Update (Patch) User
Endpoint | Method |
---|---|
| PATCH |
This endpoint is a PATCH endpoint and supports 1 or more changes through a list of Operation elements
Request-object:
{
"Operations": [
{
"op": "<Operation>",
"path": "<property-path",
"value": "<new-property-value>"
} ,
{
"op": "<Operation>",
"path": "<property-path",
"value": "<new-property-value>"
}
]
}
Property | Type | Required |
|
---|---|---|---|
op | Type of operation. | yes |
|
path | The path to the property to change | yes |
|
value | The value of the property to change | yes |
|
Sample-Request:
curl --location --request PATCH '[API-URL]/scim/Users/a3792aca-8f99-4d4b-a1f2-2b31e871b634' \
--header 'Authorization: Bearer [API-TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
"Operations": [
{
"op": "Replace",
"path": "externalId",
"value": "externalId-changed"
},
{
"op": "Replace",
"path": "userName",
"value": "newUsername@domain.com"
},
{
"op": "Replace",
"path": "active",
"value": true
},
{
"op": "Replace",
"path": "name.givenName",
"value": "NewFirstname"
},
{
"op": "Replace",
"path": "name.familyName",
"value": "NewLastname"
}
]
}'
Special Notes:
Violation of Uniqueness for ExternalId and Username results in 500-Exception
If a user within the same integration has the same ExternalId or Username ,the API will throw a 500 exception without any further explanations
Responses:
200 OK | |
---|---|
Statuscode | 200 |
Response-body: The User after the change Sample-response: {
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {},
"active": true,
"meta": {
"resourceType": "User"
},
"name": {
"familyName": "NewLastname",
"givenName": "NewFirstname"
},
"userName": "newUsername@domain.com",
"externalId": "externalId-changed",
"id": "a3792aca-8f99-4d4b-a1f2-2b31e871b634",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
|