{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"appRole": "member",
"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": "member",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
Users
Create a SCIM user
Creates a SCIM user in the workspace. For verified domains the user is added as an active member immediately. For unverified domains an invite is sent and the invite ID is returned as the SCIM user ID.
Required scopes: user_management:read-write.
POST
/
scim
/
v2
/
Users
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"appRole": "member",
"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": "member",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
Authorizations
string
required
This API uses OAuth 2.0 with the authorization code grant flow.
Body
application/jsonstring[]
required
Must include
"urn:ietf:params:scim:schemas:core:2.0:User".string
required
The user’s email address.
boolean
default:"true"
Whether the user should be active. Setting to
false creates a suspended member (only applies to verified domains).string
The user’s role in the workspace. Must be
"admin" or "member". Defaults to "member" if not specified.Response
string[]
Always
["urn:ietf:params:scim:schemas:core:2.0:User"].string
The workspace membership ID, or the workspace invite ID for unverified domains.
string
The user’s email address.
object[]
boolean
Whether the user is active. Pending invites always return
true.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": "member",
"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": "member",
"active": true,
"meta": {
"resourceType": "User",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
Was this page helpful?
⌘I