Step 1: Create User
POST {{apiPath}}/environments/{{envID}}/users
The POST /environments/{{envID}}/users
operation adds a new user resource to the specified environment.
New users must be assigned to a population. Run Read all populations to find a population ID.
The request must also set a value for the username
attribute. The username
value must be unique to an environment, across all populations.
If successful, the response returns a 201 Successfully created
message and shows the new user resource's property data.
The request will generate a userID
resource that will be used by the request in step 3.
Property | Type | Required? |
---|---|---|
population.id | String | Required |
username | String | Required |
See the User operations data model for full property descriptions.
Request Body
{"email"=>"dspanner@example.com", "name"=>{"given"=>"David", "family"=>"Spanner"}, "population"=>{"id"=>"{{popID}}"}, "username"=>"dspanner", "department"=>"engineering"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |