Update SCIM User
PUT {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}}
The PUT {{scimPath}}/environments/{{envID}}/v2/Users/{{userID}} operation updates all information about the specified SCIM user in the specified environment. All attributes of the user are replaced by the attributes in the body.
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 |
Request Body
{"schemas"=>["urn:ietf:params:scim:schemas:core:2.0:User", "urn:pingidentity:schemas:extension:2.0:PingOneUser"], "userName"=>"tmp-Isabella-Updated", "emails"=>[{"value"=>"IsabellaOfCastile@example.com", "primary"=>true}]}
RESPONSES
status: OK
{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User","urn:pingidentity:schemas:extension:2.0:PingOneUser"],"id":"2163c528-8ceb-42ce-8cbc-3d0faf05a790","meta":{"resourceType":"User","created":"2023-03-28T12:12:24.125Z","lastModified":"2023-03-28T12:32:25.186Z","location":"https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/Users/2163c528-8ceb-42ce-8cbc-3d0faf05a790"},"userName":"tmp-Isabella-Updated","active":true,"emails":[{"value":"IsabellaOfCastile@example.com","primary":true}],"urn:pingidentity:schemas:extension:2.0:PingOneUser":{"population":{"id":"cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"}}}