PingOne Platform APIs

Step 14: Create a source user

     

POST {{apiPath}}/environments/{{SourceEnvID}}/users

Create a new user resource in the source environment using a POST {{apiPath}}/environments/{{SourceEnvID}}/users request. In the request body, the email and username properties must be unique to the new user within the specified environment. Set the population.id to the population created in step 12.

This operation does not support an attribute to set the new user’s password. This will be done in the next steps.

  • The source user’s username can be retrieved from the username value returned in the response body. You will need this value in the next steps.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "email": "someone@ping.com",
    "name": {
        "given": "Source",
        "family": "User"
    },
    "population": {
        "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{SourceEnvID}}/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
    "email": "someone@ping.com",
    "name": {
        "given": "Source",
        "family": "User"
    },
    "population": {
        "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{SourceEnvID}}/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"": ""someone@ping.com""," + "\n" +
@"    ""name"": {" + "\n" +
@"        ""given"": ""Source""," + "\n" +
@"        ""family"": ""User""" + "\n" +
@"    }," + "\n" +
@"    ""population"": {" + "\n" +
@"        ""id"": ""{{SourcePopID}}""" + "\n" +
@"    }," + "\n" +
@"    ""username"": ""source_user_{{$timestamp}}""" + "\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/{{SourceEnvID}}/users"
  method := "POST"

  payload := strings.NewReader(`{
    "email": "someone@ping.com",
    "name": {
        "given": "Source",
        "family": "User"
    },
    "population": {
        "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
}`)

  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/{{SourceEnvID}}/users HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "email": "someone@ping.com",
    "name": {
        "given": "Source",
        "family": "User"
    },
    "population": {
        "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"email\": \"someone@ping.com\",\n    \"name\": {\n        \"given\": \"Source\",\n        \"family\": \"User\"\n    },\n    \"population\": {\n        \"id\": \"{{SourcePopID}}\"\n    },\n    \"username\": \"source_user_{{$timestamp}}\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{SourceEnvID}}/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/{{SourceEnvID}}/users",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "email": "someone@ping.com",
    "name": {
      "given": "Source",
      "family": "User"
    },
    "population": {
      "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{SourceEnvID}}/users',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "email": "someone@ping.com",
    "name": {
      "given": "Source",
      "family": "User"
    },
    "population": {
      "id": "{{SourcePopID}}"
    },
    "username": "source_user_{{$timestamp}}"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{SourceEnvID}}/users"

payload = json.dumps({
  "email": "someone@ping.com",
  "name": {
    "given": "Source",
    "family": "User"
  },
  "population": {
    "id": "{{SourcePopID}}"
  },
  "username": "source_user_{{$timestamp}}"
})
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/{{SourceEnvID}}/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": "someone@ping.com",\n    "name": {\n        "given": "Source",\n        "family": "User"\n    },\n    "population": {\n        "id": "{{SourcePopID}}"\n    },\n    "username": "source_user_{{$timestamp}}"\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/{{SourceEnvID}}/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": "someone@ping.com",
  "name": {
    "given": "Source",
    "family": "User"
  },
  "population": {
    "id": "{{SourcePopID}}"
  },
  "username": "source_user_{{\$timestamp}}"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"email\": \"someone@ping.com\",\n    \"name\": {\n        \"given\": \"Source\",\n        \"family\": \"User\"\n    },\n    \"population\": {\n        \"id\": \"{{SourcePopID}}\"\n    },\n    \"username\": \"source_user_{{$timestamp}}\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{SourceEnvID}}/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/457439dd-4c34-4693-8e15-16bf016a2486"
        },
        "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/e6ba8187-809d-42a0-8535-40696d3e1761"
        },
        "devices": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/devices"
        },
        "roleAssignments": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/roleAssignments"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/password"
        },
        "password.check": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/password"
        },
        "linkedAccounts": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/linkedAccounts"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486"
        },
        "memberOfGroups": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/457439dd-4c34-4693-8e15-16bf016a2486/memberOfGroups"
        }
    },
    "id": "457439dd-4c34-4693-8e15-16bf016a2486",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "account": {
        "canAuthenticate": true,
        "status": "OK"
    },
    "createdAt": "2024-04-25T21:46:59.225Z",
    "email": "someone@ping.com",
    "enabled": true,
    "identityProvider": {
        "type": "PING_ONE"
    },
    "lifecycle": {
        "status": "ACCOUNT_OK"
    },
    "mfaEnabled": false,
    "name": {
        "given": "Source",
        "family": "User"
    },
    "population": {
        "id": "e6ba8187-809d-42a0-8535-40696d3e1761"
    },
    "updatedAt": "2024-04-25T21:46:59.225Z",
    "username": "source_user_1714081619",
    "verifyStatus": "NOT_INITIATED"
}