Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Users

Replace user

Replace the specified user. Per the SCIM 2.0 specification, PUT replaces the entire user resource: any optional attribute omitted from the request body is reset to its default value.

To update individual attributes without affecting others, use the Update user endpoint, which performs a partial update via PATCH.

put/scim/v2/users/{userId}

Path parameters

userIdstring required

The ID of the user to be replaced

Request body

activeboolean

Whether the user is active. Set to false to deactivate the user.

displayNamestring

The user's display name

userNamestring email required

The user's email address.

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 request

{
  "active": true,
  "displayName": "Blob Ross",
  "userName": "blob.ross@blobsrus.co",
  "urn:omni:params:1.0:UserAttribute": {
    "good_blob": "yes"
  }
}

Response

User replaced 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"
  }
}