Step 1: Create User
POST {{apiPath}}/environments/{{envID}}/users
The POST {{apiPath}}/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.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""email"": ""dspanner@example.com""," + "\n" +
@" ""name"": {" + "\n" +
@" ""given"": ""David""," + "\n" +
@" ""family"": ""Spanner""" + "\n" +
@" }," + "\n" +
@" ""population"": {" + "\n" +
@" ""id"": ""{{popID}}""" + "\n" +
@" }," + "\n" +
@" ""username"": ""dspanner""," + "\n" +
@" ""department"": ""engineering""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/users"
method := "POST"
payload := strings.NewReader(`{
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
POST /environments/{{envID}}/users HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"dspanner@example.com\",\n \"name\": {\n \"given\": \"David\",\n \"family\": \"Spanner\"\n },\n \"population\": {\n \"id\": \"{{popID}}\"\n },\n \"username\": \"dspanner\",\n \"department\": \"engineering\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/users")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/users",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/users',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/users"
payload = json.dumps({
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "email": "dspanner@example.com",\n "name": {\n "given": "David",\n "family": "Spanner"\n },\n "population": {\n "id": "{{popID}}"\n },\n "username": "dspanner",\n "department": "engineering"\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/users")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"email": "dspanner@example.com",
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "{{popID}}"
},
"username": "dspanner",
"department": "engineering"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"email\": \"dspanner@example.com\",\n \"name\": {\n \"given\": \"David\",\n \"family\": \"Spanner\"\n },\n \"population\": {\n \"id\": \"{{popID}}\"\n },\n \"username\": \"dspanner\",\n \"department\": \"engineering\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
201 Created
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"population": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/65393df2-a368-428d-bc6e-f1c864dd3a40"
},
"devices": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/devices"
},
"roleAssignments": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/roleAssignments"
},
"password": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/password"
},
"password.reset": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/password"
},
"password.set": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/password"
},
"password.check": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/password"
},
"password.recover": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/password"
},
"linkedAccounts": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/linkedAccounts"
},
"account.sendVerificationCode": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065"
},
"memberOfGroups": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/e883e904-ff38-487e-9220-0ae019aa8065/memberOfGroups"
}
},
"id": "e883e904-ff38-487e-9220-0ae019aa8065",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"account": {
"canAuthenticate": true,
"status": "OK"
},
"createdAt": "2023-01-09T21:47:31.022Z",
"email": "dspanner@example.com",
"enabled": true,
"identityProvider": {
"type": "PING_ONE"
},
"lifecycle": {
"status": "ACCOUNT_OK"
},
"mfaEnabled": false,
"name": {
"given": "David",
"family": "Spanner"
},
"population": {
"id": "65393df2-a368-428d-bc6e-f1c864dd3a40"
},
"updatedAt": "2023-01-09T21:47:31.022Z",
"username": "dspanner",
"verifyStatus": "NOT_INITIATED"
}