v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Users

Update user

Update the specified user by applying a list of SCIM 2.0 patch operations. Attributes not referenced in the request are left unchanged.

To replace the entire user resource in a single request, use the Replace user endpoint.

<Warning> Omni does not have a reversible "deactivated" state for users. Setting `active` to `false` revokes the user's membership, which is **not reversible**: their schedules are deleted (unless transferred first) and their Personal Access Tokens are disabled. See [Revoking user memberships](/administration/users/delete) before using this operation. </Warning>
patch/scim/v2/users/{userId}

Path parameters

userIdstring required

The ID of the user to be updated

Request body

schemasstring[] required

The SCIM schema URIs for the request. Must include urn:ietf:params:scim:api:messages:2.0:PatchOp.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "path": "displayName"
    }
  ]
}

Response

User updated successfully

idstring

Unique identifier for the user

userNamestring

The user's email address

displayNamestring

The user's display name

activeboolean

Whether the user is active

schemasstring[]

SCIM information about the type of schemas used in the API. For example, urn:ietf:params:scim:schemas:core:2.0:User

urn:omni:params:1.0:UserAttributeobject

User attributes as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the Reference column in the User attributes page.

Example response

{
  "meta": {
    "resourceType": "User"
  }
}