Create Store (AzureActiveDirectorySAML2)
POST {{apiPath}}/environments/{{envID}}/propagation/stores
The POST {{apiPath}}/environments/{{envID}}/propagation/stores operation adds a new identity store resource to the specified environment resource.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Refer to Propagation store base data model and Propagation store Azure Active Directory SAML V2.0 configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
String |
Required |
Two properties appear in the response to Identity Propagation Store Metadata (AzureActiveDirectorySAML2) that are not listed in this request model. The required property,DefaultPassword, and the optional property, DoBase64Conversion (if required for ImmutableId), must be implemented as a rule mapping using Create Rule Mapping. You must write an appropriate PingOne Expression Language (PEL) expression for the rule mapping expression property. Implement DefaultPassword as part of the PEL for the rule mapping for the required password property.
This operation sends and returns the connection properties for an identity store with "type":"AzureActiveDirectorySAML2". For information on the available and required keys in the configuration object of the request body, review connectionProfiles[].connectionAttributes[] and attributeMetadata.capabilities[] in the response to POST Identity Propagation Store Metadata (AzureActiveDirectorySAML2).
Body
raw ( application/json )
{
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/stores' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/stores")
{
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" +
@" ""type"": ""AzureActiveDirectorySAML2""," + "\n" +
@" ""name"": ""azureTest2""," + "\n" +
@" ""configuration"": {" + "\n" +
@" ""CREATE_USERS"": true," + "\n" +
@" ""UPDATE_USERS"": true," + "\n" +
@" ""DEPROVISION_USERS"": true," + "\n" +
@" ""DISABLE_USERS"": true," + "\n" +
@" ""ClientId"": ""azureADClientId""," + "\n" +
@" ""TenantDomain"": ""TenantDomain""," + "\n" +
@" ""ClientSecret"": ""azureADClientSecret""," + "\n" +
@" ""REMOVE_ACTION"": ""Delete""," + "\n" +
@" ""RemoveLicensesWhenSkuIdEmpty"": true" + "\n" +
@" }," + "\n" +
@" ""image"": {" + "\n" +
@" ""href"": ""https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png""" + "\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 := "{{apiPath}}/environments/{{envID}}/propagation/stores"
method := "POST"
payload := strings.NewReader(`{
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
}`)
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}}/propagation/stores HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"type\": \"AzureActiveDirectorySAML2\",\n \"name\": \"azureTest2\",\n \"configuration\": {\n \"CREATE_USERS\": true,\n \"UPDATE_USERS\": true,\n \"DEPROVISION_USERS\": true,\n \"DISABLE_USERS\": true,\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n \"REMOVE_ACTION\": \"Delete\",\n \"RemoveLicensesWhenSkuIdEmpty\": true\n },\n \"image\": {\n \"href\": \"https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png\"\n }\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/stores")
.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}}/propagation/stores",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/stores',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/propagation/stores"
payload = json.dumps({
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": True,
"UPDATE_USERS": True,
"DEPROVISION_USERS": True,
"DISABLE_USERS": True,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": True
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
})
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}}/propagation/stores');
$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 "type": "AzureActiveDirectorySAML2",\n "name": "azureTest2",\n "configuration": {\n "CREATE_USERS": true,\n "UPDATE_USERS": true,\n "DEPROVISION_USERS": true,\n "DISABLE_USERS": true,\n "ClientId": "azureADClientId",\n "TenantDomain": "TenantDomain",\n "ClientSecret": "azureADClientSecret",\n "REMOVE_ACTION": "Delete",\n "RemoveLicensesWhenSkuIdEmpty": true\n },\n "image": {\n "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"\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("{{apiPath}}/environments/{{envID}}/propagation/stores")
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({
"type": "AzureActiveDirectorySAML2",
"name": "azureTest2",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"type\": \"AzureActiveDirectorySAML2\",\n \"name\": \"azureTest2\",\n \"configuration\": {\n \"CREATE_USERS\": true,\n \"UPDATE_USERS\": true,\n \"DEPROVISION_USERS\": true,\n \"DISABLE_USERS\": true,\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n \"REMOVE_ACTION\": \"Delete\",\n \"RemoveLicensesWhenSkuIdEmpty\": true\n },\n \"image\": {\n \"href\": \"https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png\"\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/stores")!,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
{
"id": "b862b193-08b2-466e-aba7-a44974116c74",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-11-29T13:54:52.782Z",
"updatedAt": "2022-11-29T13:54:52.782Z",
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
},
"type": "AzureActiveDirectorySAML2",
"status": "INACTIVE",
"configuration": {
"CREATE_USERS": true,
"UPDATE_USERS": true,
"DEPROVISION_USERS": true,
"DISABLE_USERS": true,
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
"REMOVE_ACTION": "Delete",
"RemoveLicensesWhenSkuIdEmpty": true
},
"name": "azureTest2",
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/b862b193-08b2-466e-aba7-a44974116c74"
},
"update": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/b862b193-08b2-466e-aba7-a44974116c74"
},
"delete": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/b862b193-08b2-466e-aba7-a44974116c74"
}
}
}