OMomni
Users

Replace user

Changed on

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}

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 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"
  },
  "urn:omni:params:scim:schemas:extension:user:2.0": {
    "userType": "Member",
    "emailLinkSignIn": true
  }
}

Response

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