OMomni
Users

Update user

Changed on

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}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/scim/v2/users/{userId}
  • Auth
    HTTP bearer

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 required

Unique identifier for the user

userNamestring required

The user's email address

displayNamestring required

The user's display name

activeboolean required

Whether the user is active

schemasstring[] required

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 required

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. A value is a string, a number, an array of strings or an array of numbers for a multi-value attribute, or null. Numbers appear only for legacy values stored before Omni started saving attribute values as strings.

Example response

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

Changes

  • 43290040f88fRevision changes
    • info

      added the new optional request property ////

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status