Create SCIM User

POST {{scimPath}}/environments/{{envID}}/v2/Users

The POST {{scimPath}}/environments/{{envID}}/v2/Users operation creates a SCIM user in the specified environment.

Prerequisites

See SCIM and SCIM Users for important overview information.

See the SCIM user data model for full property descriptions.

Property	Type	Required
`addresses.country`	String	Optional
`addresses.formatted`	String	Optional
`addresses.locality`	String	Optional
`addresses.postalCode`	String	Optional
`addresses.region`	String	Optional
`addresses.streetAddress`	String	Optional
`addresses`	Object	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

{"userName"=>"tmp-IsabellaI-12", "name"=>{"formatted"=>"Isabella", "familyName"=>"Castile", "givenName"=>"Isabella", "middleName"=>"of", "honorificPrefix"=>"Ms."}, "nickName"=>"Isa", "title"=>"Principal Engineer", "preferredLanguage"=>"en", "emails"=>[{"value"=>"IsabellaOfCastile@example.com", "primary"=>true}], "phoneNumbers"=>[{"value"=>"+1.215-987-6543", "type"=>"primary", "primary"=>true}], "addresses"=>[{"streetAddress"=>"8 Mile Rd.", "locality"=>"Detroit", "region"=>"MI", "postalCode"=>"48203", "country"=>"US", "primary"=>true}], "urn:pingidentity:schemas:extension:2.0:PingOneUser"=>{"population"=>{"id"=>"{{popID}}"}}}

RESPONSES

status: Created

{&quot;schemas&quot;:[&quot;urn:ietf:params:scim:schemas:core:2.0:User&quot;,&quot;urn:pingidentity:schemas:extension:2.0:PingOneUser&quot;],&quot;id&quot;:&quot;14c9726d-861b-45c0-b464-92f546003d26&quot;,&quot;meta&quot;:{&quot;resourceType&quot;:&quot;User&quot;,&quot;created&quot;:&quot;2023-03-07T19:24:28.621Z&quot;,&quot;lastModified&quot;:&quot;2023-03-07T19:24:28.621Z&quot;,&quot;location&quot;:&quot;https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/Users/14c9726d-861b-45c0-b464-92f546003d26&quot;},&quot;userName&quot;:&quot;tmp-IsabellaI-12&quot;,&quot;name&quot;:{&quot;formatted&quot;:&quot;Isabella&quot;,&quot;familyName&quot;:&quot;Castile&quot;,&quot;givenName&quot;:&quot;Isabella&quot;,&quot;middleName&quot;:&quot;of&quot;,&quot;honorificPrefix&quot;:&quot;Ms.&quot;},&quot;nickName&quot;:&quot;Isa&quot;,&quot;title&quot;:&quot;Principal Engineer&quot;,&quot;preferredLanguage&quot;:&quot;en&quot;,&quot;active&quot;:true,&quot;emails&quot;:[{&quot;value&quot;:&quot;IsabellaOfCastile@example.com&quot;,&quot;primary&quot;:true}],&quot;phoneNumbers&quot;:[{&quot;value&quot;:&quot;+1.215-987-6543&quot;,&quot;type&quot;:&quot;primary&quot;,&quot;primary&quot;:true}],&quot;addresses&quot;:[{&quot;streetAddress&quot;:&quot;8 Mile Rd.&quot;,&quot;locality&quot;:&quot;Detroit&quot;,&quot;region&quot;:&quot;MI&quot;,&quot;postalCode&quot;:&quot;48203&quot;,&quot;country&quot;:&quot;US&quot;,&quot;primary&quot;:true}],&quot;urn:pingidentity:schemas:extension:2.0:PingOneUser&quot;:{&quot;population&quot;:{&quot;id&quot;:&quot;cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a&quot;}}}