Patch Direct-mapped User
PATCH {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers/{{userID}}
The PATCH {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers/{{userID}} operation replaces some information about the specified user in the specified environment. Only those atributes specified in the body are changed.
See Direct-mapped user data model for full property descriptions.
| Property | Type | Required |
|---|---|---|
accountId | String | Optional |
address.countryCode | String | Optional |
address.locality | String | Optional |
address.postalCode | String | Optional |
address.region | String | Optional |
address.streetAddress | String | Optional |
email | String | Optional |
externalId | String | Optional |
locale | String | Optional |
mobilePhone | 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 |
nickname | String | Optional |
password | String | Optional |
photo.href | String | Optional |
population.id | String | Required/Optional |
preferredLanguage | String | Optional |
primaryPhone | String | Optional |
resourceType | String | Required |
timezone | String | Optional |
title | String | Optional |
type | String | Optional |
username | String | Required |
Request Body
{"schemas"=>["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations"=>[{"op"=>"replace", "path"=>"username", "value"=>"tmp-dm-user-1-PATCHED"}, {"op"=>"remove", "path"=>"nickname"}, {"op"=>"add", "path"=>"name.middle", "value"=>"midNofDMU"}]}
RESPONSES
status: OK
{"schemas":["urn:pingidentity:schemas:2.0:DirectMappedUser"],"id":"f0a13f5d-3314-49c8-aede-86a059461728","meta":{"created":"2022-09-15T15:48:51.428Z","lastModified":"2023-03-07T19:21:02.477Z","resourceType":"User","location":"https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/DirectMappedUsers/f0a13f5d-3314-49c8-aede-86a059461728"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"account":{"canAuthenticate":true,"status":"OK"},"enabled":true,"identityProvider":{"type":"PING_ONE"},"lifecycle":{"status":"ACCOUNT_OK"},"mfaEnabled":false,"name":{"formatted":"Rawnald Gregory Erickson II","given":"Rawnald","middle":"midNofDMU","family":"Erickson","honorificPrefix":"Mr.","honorificSuffix":"II"},"population":{"id":"cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"},"primaryPhone":"1234567890","username":"tmp-dm-user-1-PATCHED","verifyStatus":"NOT_INITIATED"}