Step 3: Create User
POST {{apiPath}}/environments/{{envID}}/users
The POST /environments/{{envID}}/users
operation creates the new user resource in the specified environment. Associate the user with the population you just created.
Property | Type | Required? |
---|---|---|
accountId | String | Optional |
address.streetAddress | String | Optional |
address.countryCode | String | Optional |
address.locality | String | Optional |
address.region | String | Optional |
address.postalCode | String | Optional |
address.zipCode | String | Optional |
email | String | Optional |
locale | Array [String] | Optional |
mobilePhone | String | Optional |
name.given | String | Optional |
name.family | String | Optional |
name.middle | String | Optional |
name.honorificPrefix | String | Optional |
name.honorificSuffix | String | Optional |
name.formatted | String | Optional |
nickname | String | Optional |
photo.href | String | Optional |
population.id | String | Required |
preferredLanguage | String | Optional |
primaryPhone | String | Optional |
timeZone | String | Optional |
title | String | Optional |
type | String | Optional |
username | String | Required |
See the User operations data model for full property descriptions.
Request Body
{"email"=>"marysample@example.com", "name"=>{"given"=>"Mary", "family"=>"Sample"}, "population"=>{"id"=>"{{popID}}"}, "username"=>"marysample", "department"=>"engineering", "locales"=>["Sydney", "London"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |