Create Direct-mapped User
POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers
The POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers operation creates a user in the specified environment.
Prerequisites
- See SCIM and Direct-mapped Users for important overview information.
See the 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
{"address"=>{"streetAddress"=>"221 Baker St.", "region"=>"London", "countryCode"=>"UK"}, "email"=>"directmapped@example.com", "name"=>{"formatted"=>"Rawnald Gregory Erickson II", "given"=>"Rawnald", "family"=>"Erickson", "honorificPrefix"=>"Mr.", "honorificSuffix"=>"II"}, "nickname"=>"Ronnie", "preferredLanguage"=>"en", "primaryPhone"=>"1234567890", "username"=>"tmp-dm-user-1", "population"=>{"id"=>"{{popID}}"}}
RESPONSES
status: Created
{"schemas":["urn:pingidentity:schemas:2.0:DirectMappedUser"],"id":"39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba","meta":{"created":"2023-03-07T19:03:33.658Z","lastModified":"2023-03-07T19:03:33.658Z","resourceType":"User","location":"https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/DirectMappedUsers/39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"account":{"canAuthenticate":true,"status":"OK"},"address":{"streetAddress":"221 Baker St.","region":"London","countryCode":"UK"},"email":"directmapped@example.com","enabled":true,"identityProvider":{"type":"PING_ONE"},"lifecycle":{"status":"ACCOUNT_OK"},"mfaEnabled":false,"name":{"formatted":"Rawnald Gregory Erickson II","given":"Rawnald","family":"Erickson","honorificPrefix":"Mr.","honorificSuffix":"II"},"nickname":"Ronnie","population":{"id":"cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"},"preferredLanguage":"en","primaryPhone":"1234567890","username":"tmp-dm-user-1","verifyStatus":"NOT_INITIATED"}