Update a SCIM user by ID

Updates a user in the organization. The updated user with its attributes is returned to the client. You can update the value for the following attributes:

• name.familyName – The last name of the user.
• name.givenName – The first name of the user.

You cannot update the value for the following attributes:

• userName – Mapped to the email of the user.

If you send the active attribute in the payload with: 

• a value of false, the user is permanently deleted from Opti ID.
• a value of true, it does not affect the outcome of the operation.

SCIM RFC compliance

Aside from the notes above, this endpoint fully complies with the SCIM RFC as it relates to the supported schema.

API payload

{  
  "UserName": "{{email}}",  
  "Active": true | false,  
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],  
  "externalId": "${\_\_UUID}",  
    "name": {  
      "familyName": "{{last-name}}",  
      "givenName": "{{first-name}}"  
    }  
}

Error conditions

• 404 (Not Found) – A user with the specified ID is not found.