Step 6: Create a user

POST {{apiPath}}/environments/{{envID}}/users

This example shows the POST /environments/{{envID}}/users operation to create a new user.

In this request:

  • The request body must include the population ID that you just created in the previous step. The {{journeyPopID}} placeholder variable in the request body represents this population ID. If you're using the supplied Qodex collection, you'll find that the {{journeyPopID}} variable is already set to your population ID.

The request must also include the required properties:

  • email. The unique email address for the new user.

  • username. A name for the new user. This must be a unique name within your environment.

    • The response returns a Status: 201 created message and shows the new user's coniguration data.
    • The response data includes the user's id property. This is needed to set the new user's password in the next step.

See the following topics to learn more about users:

Request Body

{"email"=>"my.email@pingidentity.com", "name"=>{"given"=>"Test", "family"=>"DaVinciFlowUser"}, "population"=>{"id"=>"{{dvFlowPopID}}"}, "username"=>"dv_solution_user_{{$timestamp}}"}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring