Modify a SCIM user by ID

The patch user endpoint selectively modifies the attributes of the user indicated by the ID parameter. You can replace (but not add or remove) the values for the following attributes:

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

You cannot replace, add, or remove the values 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.

SCIM RFC compliance

Aside from the notes above, this endpoint fully complies with the SCIM RFC as it relates to the supported schema. Complex paths are also not supported, like the following examples:

• "path":"addresses[type eq \"work\"]"
• "path":"members[value eq \"2819c223-7f76-453a-919d-413861904646\"].displayName"

API payload

{  
    "schemas": [  
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"  
    ],  
    "Operations": [  
        {  
            "op": "replace",  
            "path": "name.givenName",  
            "value": "ryan3"  
        }  
    ]  
}

Other flavors of the payload are supported as well. For example, a replace operation without a path where the value implies the attribute path and its value.

Error conditions

• 404 (Not Found) – A user with the specified ID is not found.
• 400 (Bad Request) – The patch operation syntax is invalid, or Opti ID does not support the patch operation.