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": "[e-mail]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "appRole": "admin",
  "active": true
}

200

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
  "userName": "[e-mail]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "emails": [
    {
      "value": "[e-mail]",
      "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

Authorization · string · required

This API uses OAuth 2.0 with the authorization code grant flow.

Path

user_id · string · required

The workspace membership ID or workspace invite ID of the user to update.

Body

application/json

schemas · string[] · required

Must include "urn:ietf:params:scim:schemas:core:2.0:User".

userName · string · required

The user’s email address. Must be a valid email.

name · object

Show name

givenName · string

The user’s first name.

familyName · string

The user’s last name.

active · boolean

Whether the user should be active. Setting to false suspends the member and revokes their active sessions.

appRole · string

The user’s role: "admin" or "member".

Response

Returns 200 with the updated user. Returns 204 No Content when setting active to false on a pending invite; deprovisioning an active member returns 200.

schemas · string[]

Always ["urn:ietf:params:scim:schemas:core:2.0:User"].

id · string

The workspace membership ID or workspace invite ID.

userName · string

The user’s email address.

name · object

Show name

givenName · string

The user’s first name.

familyName · string

The user’s last name.

emails · object[]

Show emails[]

value · string

The email address.

primary · boolean

Whether this is the primary email address.

type · string

Always "work".

active · boolean

Whether the user is active.

appRole · string

The user’s role: "admin" or "member". Not present for suspended users.

meta · object

Show meta

resourceType · string

Always "User".

created · string

ISO 8601 timestamp of when the user was created.

lastModified · string

ISO 8601 timestamp of when the user was last modified.

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[e-mail]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "appRole": "admin",
  "active": true
}

200

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
  "userName": "[e-mail]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "emails": [
    {
      "value": "[e-mail]",
      "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"
  }
}