{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"appRole": "admin",
"active": true
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"emails": [
{
"value": "john.doe@example.com",
"primary": true,
"type": "work"
}
],
"appRole": "admin",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
{}
Users
Update a SCIM user
Fully replaces a SCIM user’s attributes. Returns 200 with the updated user. Returns 204 when setting active to false on a pending invite.
Required scopes: user_management:read-write.
PUT
/
scim
/
v2
/
Users
/
{user_id}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"appRole": "admin",
"active": true
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"emails": [
{
"value": "john.doe@example.com",
"primary": true,
"type": "work"
}
],
"appRole": "admin",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
{}
Authorizations
string
required
This API uses OAuth 2.0 with the authorization code grant flow.
Path
string
required
The workspace membership ID or workspace invite ID of the user to update.
Body
application/jsonstring[]
required
Must include
"urn:ietf:params:scim:schemas:core:2.0:User".string
required
The user’s email address. Must be a valid email.
boolean
Whether the user should be active. Setting to
false suspends the member and revokes their active sessions.string
The user’s role:
"admin" or "member".Response
Returns200 with the updated user. Returns 204 No Content when setting active to false on a pending invite; deprovisioning an active member returns 200.
string[]
Always
["urn:ietf:params:scim:schemas:core:2.0:User"].string
The workspace membership ID or workspace invite ID.
string
The user’s email address.
object[]
boolean
Whether the user is active.
string
The user’s role:
"admin" or "member". Not present for suspended users.object
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"appRole": "admin",
"active": true
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"emails": [
{
"value": "john.doe@example.com",
"primary": true,
"type": "work"
}
],
"appRole": "admin",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
{}
Was this page helpful?
⌘I