Add, Update or Remove User Information

patch

/rest/v19/scim/Users/{id}

This endpoint performs an operation to add user information, update existing user information or remove existing user information for a specified user. The endpoint supports a single operation request or multiple operation requests performed sequentially.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Patch request model
Type: object
Title: Patch request model
Request to update a user with minimal user payload
Show Source
Nested Schema : Operations
Type: array
Title: Operations
update patch operation
Show Source
Nested Schema : Collab queue operation properties
Type: object
Title: Collab queue operation properties
Show Source
  • Title: Description
    Description of the operation. This is only intended for human consumption and its format may change at any time.
  • Title: Submission time
    Approximate time when the operation was submitted, in ISO8601 format. This is NOT used to determine the ordering of operations within the queue.
  • Title: Submitter company name
    Company name of the user who submitted the operation.
  • Title: Submitter login name
    Login name of the user who submitted the operation.
  • Title: Operation uuid
    Unique identifier of the operation.
Back to Top

Response

Supported Media Types

Default Response

Response of the updated user.
Body ()
Root Schema : user-response
Type: object
Show Source
Nested Schema : Email
Type: array
Title: Email
Email of the User
Show Source
Nested Schema : enterpriseUser
Type: object
Show Source
Nested Schema : extensionUser
Type: object
Show Source
Nested Schema : metaData
Type: object
Show Source
Nested Schema : Name
Type: object
Title: Name
Full name of the user
Show Source
Nested Schema : Phone Numbers
Type: array
Title: Phone Numbers
Phone numbers of the User
Show Source
Nested Schema : Schemas
Type: array
Title: Schemas
Schemas used in the response
Show Source
Nested Schema : email
Type: object
Show Source
Nested Schema : addresses
Type: array
Show Source
Nested Schema : address
Type: object
Show Source
Nested Schema : Shipping/Billing Full name
Type: object
Title: Shipping/Billing Full name
Shipping/Billing Full name
Show Source
Nested Schema : phoneNumber
Type: object
Show Source
Back to Top