Identity Propagation Store Metadata (AzureActiveDirectorySAML2)
POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2
The POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2 endpoint returns metadata from the specified Azure Active Directory SAML2 identity store.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Refer to the Propagation store Azure Active Directory SAML V2.0 configuration data model for full property descriptions.
Use the current or proposed configuration in the body to return static and dynamic metadata, or an empty body ({}) to retrieve only static metadata.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2")
{
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" +
@" ""ClientId"": ""azureADClientId""," + "\n" +
@" ""TenantDomain"": ""TenantDomain""," + "\n" +
@" ""ClientSecret"": ""azureADClientSecret""," + "\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/storeMetadata/AzureActiveDirectorySAML2"
method := "POST"
payload := strings.NewReader(`{
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
}`)
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/storeMetadata/AzureActiveDirectorySAML2 HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"ClientId": "azureADClientId",
"TenantDomain": "TenantDomain",
"ClientSecret": "azureADClientSecret",
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2")
.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/storeMetadata/AzureActiveDirectorySAML2",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": "{\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n}",
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: '{\n "ClientId": "azureADClientId",\n "TenantDomain": "TenantDomain",\n "ClientSecret": "azureADClientSecret",\n}'
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2"
payload = "{\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n}"
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/storeMetadata/AzureActiveDirectorySAML2');
$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 "ClientId": "azureADClientId",\n "TenantDomain": "TenantDomain",\n "ClientSecret": "azureADClientSecret",\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/storeMetadata/AzureActiveDirectorySAML2")
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 = "{\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n}"
response = http.request(request)
puts response.read_body
let parameters = "{\n \"ClientId\": \"azureADClientId\",\n \"TenantDomain\": \"TenantDomain\",\n \"ClientSecret\": \"azureADClientSecret\",\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/AzureActiveDirectorySAML2")!,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
200 OK
{
"information": {
"imageUrl": "Image URL",
"key": "AzureActiveDirectorySAML2",
"version": "2.2",
"displayName": "Office 365 Connector",
"identityProvider": true,
"baseURLRequired": false,
"connectionInformationRequired": true
},
"connectionProfiles": [
{
"name": "OAuth Bearer Token",
"description": "Authentication Scheme using the OAuth Bearer Token Standard",
"connectionAttributes": [
{
"key": "ClientId",
"displayLabel": "Application ID",
"description": "Application ID",
"required": true,
"typeBoolean": false,
"sensitive": true
},
{
"key": "ClientSecret",
"displayLabel": "Application Secret",
"description": "Application Secret",
"required": true,
"typeBoolean": false,
"sensitive": true
},
{
"key": "TenantDomain",
"displayLabel": "Tenant Domain",
"description": "Tenant Domain",
"required": true,
"typeBoolean": false,
"sensitive": false
},
{
"key": "DoBase64Conversion",
"displayLabel": "Do a base64 conversion on ImmutableId (assumes it is mapped to a hex number)",
"description": "Do a base64 conversion on ImmutableId (assumes it is mapped to a hex number)",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "RemoveLicensesWhenSkuIdEmpty",
"displayLabel": "Remove licenses from user when skuId is empty",
"description": "Remove licenses from user when skuId is empty",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "DefaultPassword",
"displayLabel": "Global default password",
"description": "Global default password",
"required": true,
"typeBoolean": false,
"sensitive": true
},
{
"key": "CREATE_NEW_USERS",
"displayLabel": "User Create",
"description": "User Create",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "UPDATE_NEW_USERS",
"displayLabel": "User Update",
"description": "User Update",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "REMOVE_USERS_PROV_OPT",
"displayLabel": "User Disable / Delete",
"description": "User Disable / Delete",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "PROVISION_DISABLED_USERS_PROV_OPT",
"displayLabel": "Provision Disabled Users",
"description": "Provision Disabled Users",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "DEPROVISION_USER_ACTION_PROV_OPT",
"displayLabel": "Remove User Action",
"description": "Remove User Action",
"required": false,
"typeBoolean": false,
"sensitive": false,
"possibleValues": [
"Disable",
"Delete"
]
}
],
"specUrl": "http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01",
"documentationUrl": "http://example.com/help/oauth.html",
"primary": false
}
],
"attributeMetadata": {
"capabilities": [
{
"type": "CREATE_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "UPDATE_GROUPS",
"maxResources": 1
},
{
"type": "DELETE_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "CREATE_USERS",
"maxResources": 1
},
{
"type": "UPDATE_USERS",
"maxResources": 1
},
{
"type": "DELETE_GROUPS",
"maxResources": 1
},
{
"type": "CREATE_GROUPS",
"maxResources": 1
},
{
"type": "GET_INFO",
"maxResources": 1
},
{
"type": "GET_GROUPS",
"maxResources": 1
},
{
"type": "CHECK_CONNECTION",
"maxResources": 1
},
{
"type": "GET_MEMBERS_OF_GROUP",
"maxResources": 1
},
{
"type": "GET_ALL_GROUPS",
"maxResources": 1
},
{
"type": "GET_CONNECTION_PROFILES",
"maxResources": 1
},
{
"type": "GET_ATTRIBUTES",
"maxResources": 1
},
{
"type": "GET_USERS",
"maxResources": 1
},
{
"type": "GET_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "DELETE_USERS",
"maxResources": 1
}
],
"userAttributes": {
"country": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "country",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "country",
"referenceAttribute": [
"work_country"
]
},
"resetPassword": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"creatable": true,
"updateable": true,
"defaultedOnCreate": true,
"unique": false,
"sensitive": false,
"displayName": "resetPassword",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"key": "resetPassword",
"defaultValue": true
},
"preferredLanguage": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "preferredLanguage",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "preferredLanguage",
"referenceAttribute": [
"language"
]
},
"telephoneNumber": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "telephoneNumber",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "telephoneNumber",
"referenceAttribute": [
"work_phone"
]
},
"city": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "city",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "city",
"referenceAttribute": [
"work_city"
]
},
"displayName": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "displayName",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"key": "displayName",
"referenceAttribute": [
"display_name"
]
},
"jobTitle": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "jobTitle",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "jobTitle",
"referenceAttribute": [
"title"
]
},
"postalCode": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "postalCode",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "postalCode",
"referenceAttribute": [
"work_postal_code"
]
},
"accountEnabled": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"creatable": true,
"updateable": true,
"defaultedOnCreate": true,
"unique": false,
"sensitive": false,
"displayName": "accountEnabled",
"requiredOnUpdate": true,
"requiredOnCreate": true,
"key": "accountEnabled",
"defaultValue": true,
"referenceAttribute": [
"active"
]
},
"password": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": false,
"unique": false,
"sensitive": true,
"displayName": "password",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "password",
"referenceAttribute": [
"password"
]
},
"surname": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "surname",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "surname",
"referenceAttribute": [
"family_name"
]
},
"state": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "state",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "state",
"referenceAttribute": [
"work_region"
]
},
"memberOf": {
"type": "STRING",
"attributeType": "STRING",
"creatable": false,
"updateable": false,
"unique": false,
"sensitive": false,
"displayName": "memberOf",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "memberOf"
},
"department": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "department",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "department",
"referenceAttribute": [
"department"
]
},
"userPrincipalName": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": true,
"sensitive": false,
"displayName": "userPrincipalName",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"key": "userPrincipalName",
"referenceAttribute": [
"userPrincipalName"
]
},
"skuId": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "skuId",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"maxNumberOfValues": 2147483647,
"key": "skuId",
"maxLength": 2147483647,
"minLength": 1
},
"mailNickname": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "mailNickname",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"key": "mailNickname",
"referenceAttribute": [
"username"
]
},
"physicalDeliveryOfficeName": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "physicalDeliveryOfficeName",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "physicalDeliveryOfficeName"
},
"manager": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "manager",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "manager",
"referenceAttribute": [
"manager_display_name"
]
},
"givenName": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "givenName",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "givenName",
"referenceAttribute": [
"given_name"
]
},
"mobile": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "mobile",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "mobile",
"referenceAttribute": [
"mobile_phone"
]
},
"facsimileTelephoneNumber": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "facsimileTelephoneNumber",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "facsimileTelephoneNumber",
"referenceAttribute": [
"fax_phone"
]
},
"disabledPlans": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "disabledPlans",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"maxNumberOfValues": 2147483647,
"key": "disabledPlans",
"maxLength": 2147483647,
"minLength": 1
},
"otherMails": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "otherMails",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"maxNumberOfValues": 2147483647,
"key": "otherMails",
"maxLength": 2147483647,
"minLength": 1
},
"immutableId": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": false,
"unique": true,
"sensitive": false,
"displayName": "immutableId",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"key": "immutableId",
"referenceAttribute": [
"external_id"
]
},
"streetAddress": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "streetAddress",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "streetAddress",
"referenceAttribute": [
"work_street_address"
]
},
"pingSourceDN": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": true,
"sensitive": false,
"displayName": "pingSourceDN",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "pingSourceDN",
"referenceAttribute": [
"manager_id"
]
},
"usageLocation": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "usageLocation",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "usageLocation",
"referenceAttribute": [
"locale"
]
},
"userType": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "userType",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"key": "userType",
"referenceAttribute": [
"user_type"
]
}
},
"groupAttributes": {
"displayName": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"unique": false,
"sensitive": false,
"displayName": "displayName",
"requiredOnUpdate": true,
"requiredOnCreate": true,
"key": "displayName",
"referenceAttribute": [
"display_name"
]
}
}
},
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/AzureActiveDirectorySAML2"
}
}
}