Create Direct-mapped User
POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers
The POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers operation creates a user in the specified environment.
Prerequisites
-
Refer to SCIM and Direct-mapped Users for important overview information.
Request Model
Refer to the Direct-mapped user data model for full property descriptions.
| Property | Type | Required |
|---|---|---|
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required/Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
Body
raw ( application/json )
{
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
}'
var options = new RestClientOptions("{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers")
{
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" +
@" ""address"": {" + "\n" +
@" ""streetAddress"": ""221 Baker St.""," + "\n" +
@" ""region"": ""London""," + "\n" +
@" ""countryCode"": ""UK""" + "\n" +
@" }," + "\n" +
@" ""email"": ""directmapped@example.com""," + "\n" +
@" ""name"": {" + "\n" +
@" ""formatted"": ""Rawnald Gregory Erickson II""," + "\n" +
@" ""given"": ""Rawnald""," + "\n" +
@" ""family"": ""Erickson""," + "\n" +
@" ""honorificPrefix"": ""Mr.""," + "\n" +
@" ""honorificSuffix"": ""II""" + "\n" +
@" }," + "\n" +
@" ""nickname"": ""Ronnie""," + "\n" +
@" ""preferredLanguage"": ""en""," + "\n" +
@" ""primaryPhone"": ""1234567890""," + "\n" +
@" ""username"": ""tmp-dm-user-1""," + "\n" +
@" ""population"": {" + "\n" +
@" ""id"": ""{{popID}}""" + "\n" +
@" }" + "\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 := "{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers"
method := "POST"
payload := strings.NewReader(`{
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
}`)
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}}/v2/DirectMappedUsers HTTP/1.1
Host: {{scimPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"address\": {\n \"streetAddress\": \"221 Baker St.\",\n \"region\": \"London\",\n \"countryCode\": \"UK\"\n },\n \"email\": \"directmapped@example.com\",\n \"name\": {\n \"formatted\": \"Rawnald Gregory Erickson II\",\n \"given\": \"Rawnald\",\n \"family\": \"Erickson\",\n \"honorificPrefix\": \"Mr.\",\n \"honorificSuffix\": \"II\"\n },\n \"nickname\": \"Ronnie\",\n \"preferredLanguage\": \"en\",\n \"primaryPhone\": \"1234567890\",\n \"username\": \"tmp-dm-user-1\",\n \"population\": {\n \"id\": \"{{popID}}\"\n }\n}");
Request request = new Request.Builder()
.url("{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers"
payload = json.dumps({
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
})
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('{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers');
$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 "address": {\n "streetAddress": "221 Baker St.",\n "region": "London",\n "countryCode": "UK"\n },\n "email": "directmapped@example.com",\n "name": {\n "formatted": "Rawnald Gregory Erickson II",\n "given": "Rawnald",\n "family": "Erickson",\n "honorificPrefix": "Mr.",\n "honorificSuffix": "II"\n },\n "nickname": "Ronnie",\n "preferredLanguage": "en",\n "primaryPhone": "1234567890",\n "username": "tmp-dm-user-1",\n "population": {\n "id": "{{popID}}"\n }\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("{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers")
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({
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"population": {
"id": "{{popID}}"
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"address\": {\n \"streetAddress\": \"221 Baker St.\",\n \"region\": \"London\",\n \"countryCode\": \"UK\"\n },\n \"email\": \"directmapped@example.com\",\n \"name\": {\n \"formatted\": \"Rawnald Gregory Erickson II\",\n \"given\": \"Rawnald\",\n \"family\": \"Erickson\",\n \"honorificPrefix\": \"Mr.\",\n \"honorificSuffix\": \"II\"\n },\n \"nickname\": \"Ronnie\",\n \"preferredLanguage\": \"en\",\n \"primaryPhone\": \"1234567890\",\n \"username\": \"tmp-dm-user-1\",\n \"population\": {\n \"id\": \"{{popID}}\"\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers")!,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
{
"schemas": [
"urn:pingidentity:schemas:2.0:DirectMappedUser"
],
"id": "39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba",
"meta": {
"created": "2023-03-07T19:03:33.658Z",
"lastModified": "2023-03-07T19:03:33.658Z",
"resourceType": "User",
"location": "https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/DirectMappedUsers/39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba"
},
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"account": {
"canAuthenticate": true,
"status": "OK"
},
"address": {
"streetAddress": "221 Baker St.",
"region": "London",
"countryCode": "UK"
},
"email": "directmapped@example.com",
"enabled": true,
"identityProvider": {
"type": "PING_ONE"
},
"lifecycle": {
"status": "ACCOUNT_OK"
},
"mfaEnabled": false,
"name": {
"formatted": "Rawnald Gregory Erickson II",
"given": "Rawnald",
"family": "Erickson",
"honorificPrefix": "Mr.",
"honorificSuffix": "II"
},
"nickname": "Ronnie",
"population": {
"id": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"
},
"preferredLanguage": "en",
"primaryPhone": "1234567890",
"username": "tmp-dm-user-1",
"verifyStatus": "NOT_INITIATED"
}