Patch SCIM User
PATCH {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}
The PATCH {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}} operation replaces some information about the specified SCIM user in the specified environment. Only those atributes specified in the body are changed.
Prerequisites
- See SCIM and SCIM Users for important overview information.
See the SCIM user data model for full property descriptions.
| Property | Type | Required |
|---|---|---|
addresses | Object | Optional |
addresses.country | String | Optional |
addresses.formatted | String | Optional |
addresses.locality | String | Optional |
addresses.postalCode | String | Optional |
addresses.region | String | Optional |
addresses.streetAddress | String | Optional |
emails | String | Optional |
externalId | String | Optional |
locale | String | Optional |
name.familyName | String | Optional |
name.formatted | String | Optional |
name.givenName | String | Optional |
name.honorificPrefix | String | Optional |
name.honorificSuffix | String | Optional |
name.middleName | String | Optional |
name | Object | Optional |
nickName | String | Optional |
password | String | Required |
phoneNumbers | String | Optional |
photos | Object | Optional |
preferredLanguage | String | Optional |
timezone | DateTime | Optional |
title | String | Optional |
urn:pingidentity:schemas:extension:2.0:PingOneUser.population.id | String | Optional |
userName | String | Required |
Note: The SCIM PATCH operation differs from a traditional JSON PATCH. The request body must provide a list of operations to apply sequentially to the user resource. The PATCH operation is considered atomic, and no updates will be applied if any of the provided operations fail. It is similar to an ldapmodify operation on LDAP directory servers.
Request Body
{"schemas"=>["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations"=>[{"op"=>"replace", "path"=>"userName", "value"=>"Isabella_Patched"}, {"op"=>"remove", "path"=>"nickName"}, {"op"=>"add", "path"=>"name.middleName", "value"=>"midN"}]}
RESPONSES
status: OK
{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:pingidentity:schemas:extension:2.0:PingOneUser"],"id":"239e1067-b688-4b5d-a226-f1c0a272eadc","meta":{"resourceType":"User","created":"2022-11-08T13:44:23.077Z","lastModified":"2023-03-07T19:31:50.807Z","location":"https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/Users/239e1067-b688-4b5d-a226-f1c0a272eadc"},"userName":"Isabella_Patched","name":{"middleName":"midN"},"active":true,"emails":[{"value":"IsabellaOfCastile@example.com","primary":true}],"urn:pingidentity:schemas:extension:2.0:PingOneUser":{"population":{"id":"d230df13-2ab9-4aeb-ba7d-188ad97a2163"}}}