Identity Propagation Store Metadata (PingOne)
POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOneThe POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOne endpoint returns metadata from the specified PingOne identity store.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Refer to the Propagation store PingOne 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 |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Sring |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
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/PingOne' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
}'var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOne")
{
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" +
@" ""ENVIRONMENT_ID"": ""{{envID}}""," + "\n" +
@" ""REGION"": ""North America""" + "\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/PingOne"
method := "POST"
payload := strings.NewReader(`{
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
}`)
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/PingOne HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
}OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"ENVIRONMENT_ID\": \"{{envID}}\",\n \"REGION\": \"North America\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOne")
.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/PingOne",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOne',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
})
};
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/PingOne"
payload = json.dumps({
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
})
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/PingOne');
$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 "ENVIRONMENT_ID": "{{envID}}",\n "REGION": "North America"\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/PingOne")
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({
"ENVIRONMENT_ID": "{{envID}}",
"REGION": "North America"
})
response = http.request(request)
puts response.read_bodylet parameters = "{\n \"ENVIRONMENT_ID\": \"{{envID}}\",\n \"REGION\": \"North America\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/PingOne")!,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": "PingOne",
"version": "1.0",
"displayName": "PingOne Connector",
"identityProvider": true,
"baseURLRequired": false,
"connectionInformationRequired": true
},
"connectionProfiles": [
{
"name": "OAuth Client Credentials",
"description": "Authentication Scheme using Client Id, Client Secret, and Token URL",
"connectionAttributes": [
{
"key": "ENVIRONMENT_ID",
"displayLabel": "Environment ID",
"description": "Environment ID",
"required": false,
"sensitive": false
},
{
"key": "CREATE_USERS_PROV_OPT",
"displayLabel": "User Create",
"description": "User Create",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "UPDATE_USERS_PROV_OPT",
"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": "REMOVE_ACTION",
"displayLabel": "Remove User Action",
"description": "Remove User Action",
"required": false,
"sensitive": false,
"possibleValues": [
"Disable",
"Delete"
]
},
{
"key": "MFA_USER_DEVICE_MANAGEMENT",
"displayLabel": "MFA User Device Management",
"description": "MFA User Device Management",
"required": false,
"sensitive": false,
"possibleValues": [
"Merge with devices in PingOne",
"Overwrite devices in PingOne"
]
},
{
"key": "REGION",
"displayLabel": "Region",
"description": "Region",
"required": false,
"sensitive": false,
"possibleValues": [
"North America (US)",
"North America (Canada)",
"European Union",
"Asia-Pacific"
]
},
{
"key": "DEFAULT_AUTH_METHOD",
"displayLabel": "Default Authentication Method for New Users",
"description": "Default Authentication Method for New Users",
"required": false,
"sensitive": false,
"possibleValues": [
"Email 1",
"SMS 1",
"Voice 1"
]
},
{
"key": "CLIENT_ID",
"displayLabel": "OAuth 2 Client ID",
"description": "Client ID",
"required": false,
"sensitive": false
},
{
"key": "CLIENT_SECRET",
"displayLabel": "OAuth 2 Client Secret",
"description": "Client Secret",
"required": false,
"sensitive": true
}
],
"specUrl": "https://tools.ietf.org/html/draft-ietf-oauth-v2-31",
"documentationUrl": "http://example.com/help/oauth.html",
"primary": false
},
{
"name": "OAuth Client Credentials for Internal Use",
"description": "OAuth connection profile intended for internal use by PingOne Provisioning",
"connectionAttributes": [
{
"key": "ENVIRONMENT_ID",
"displayLabel": "Environment ID",
"description": "Environment ID",
"required": false,
"sensitive": false
},
{
"key": "CREATE_USERS_PROV_OPT",
"displayLabel": "User Create",
"description": "User Create",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "UPDATE_USERS_PROV_OPT",
"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": "REMOVE_ACTION",
"displayLabel": "Remove User Action",
"description": "Remove User Action",
"required": false,
"sensitive": false,
"possibleValues": [
"Disable",
"Delete"
]
},
{
"key": "MFA_USER_DEVICE_MANAGEMENT",
"displayLabel": "MFA User Device Management",
"description": "MFA User Device Management",
"required": false,
"sensitive": false,
"possibleValues": [
"Merge with devices in PingOne",
"Overwrite devices in PingOne"
]
},
{
"key": "REGION",
"displayLabel": "Region",
"description": "Region",
"required": false,
"sensitive": false,
"possibleValues": [
"North America (US)",
"North America (Canada)",
"European Union",
"Asia-Pacific"
]
},
{
"key": "DEFAULT_AUTH_METHOD",
"displayLabel": "Default Authentication Method for New Users",
"description": "Default Authentication Method for New Users",
"required": false,
"sensitive": false,
"possibleValues": [
"Email 1",
"SMS 1",
"Voice 1"
]
},
{
"key": "CLIENT_ID",
"displayLabel": "OAuth 2 Client ID",
"description": "Client ID",
"required": false,
"sensitive": false
},
{
"key": "CLIENT_SECRET",
"displayLabel": "OAuth 2 Client Secret",
"description": "Client Secret",
"required": false,
"sensitive": true
},
{
"key": "P1_AUTH_URL",
"displayLabel": "PingOne auth URL",
"description": "PingOne auth URL",
"required": false,
"sensitive": false
},
{
"key": "P1_DIRECTORY_BASE_URL",
"displayLabel": "PingOne directory-api base URL",
"description": "PingOne directory-api base URL",
"required": false,
"sensitive": false
},
{
"key": "P1_MFA_DEVICE_BASE_URL",
"displayLabel": "PingOne mfa-device-mgt base URL",
"description": "PingOne mfa-device-mgt base URL",
"required": false,
"sensitive": false
},
{
"key": "P1_IDENTITY_PROVIDER_BASE_URL",
"displayLabel": "PingOne identity-provider-mgmt base URL",
"description": "PingOne identity-provider-mgmt base URL",
"required": false,
"sensitive": false
}
],
"specUrl": "https://tools.ietf.org/html/draft-ietf-oauth-v2-31",
"documentationUrl": "http://example.com/help/oauth.html",
"primary": false
}
],
"attributeMetadata": {
"capabilities": [
{
"type": "GET_ALL_GROUPS",
"maxResources": 1
},
{
"type": "GET_GROUPS",
"maxResources": 1
},
{
"type": "GET_ALL_USERS",
"maxResources": 1
},
{
"type": "DELETE_USERS",
"maxResources": 1
},
{
"type": "CREATE_GROUPS",
"maxResources": 1
},
{
"type": "UPDATE_GROUPS",
"maxResources": 1
},
{
"type": "UPDATE_USERS",
"maxResources": 1
},
{
"type": "GET_CONNECTION_PROFILES",
"maxResources": 1
},
{
"type": "GET_ATTRIBUTES",
"maxResources": 1
},
{
"type": "GET_INFO",
"maxResources": 1
},
{
"type": "CHECK_CONNECTION",
"maxResources": 1
},
{
"type": "GET_USERS",
"maxResources": 1
},
{
"type": "CREATE_USERS",
"maxResources": 1
},
{
"type": "DELETE_GROUPS",
"maxResources": 1
}
],
"enhancements": [
"MEMBERSHIP_AS_GROUP_ATTRIBUTE"
],
"userAttributes": {
"mfaDeviceVoice2": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Voice 2",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceVoice2",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"lastName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Last Name",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "lastName",
"caseSensitive": false,
"maxLength": 256,
"minLength": 0,
"referenceAttribute": [
"family_name"
]
},
"country": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Country",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "[A-Z]{2}",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "country",
"caseSensitive": true,
"maxLength": 2,
"minLength": 0,
"referenceAttribute": [
"work_country"
]
},
"mfaDeviceVoice3": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Voice 3",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceVoice3",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"preferredLanguage": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Preferred Language",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"standard": "IETF BCP 47",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "preferredLanguage",
"caseSensitive": false,
"minLength": 0,
"defaultValue": "en-us",
"referenceAttribute": [
"language"
]
},
"mfaDeviceVoice1": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Voice 1",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceVoice1",
"caseSensitive": false,
"referenceAttribute": [
"mobile_phone"
]
},
"ZIPCode": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "ZIP Code",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "ZIPCode",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"work_postal_code"
]
},
"city": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "City",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "city",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"work_city"
]
},
"timezone": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Timezone",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"standard": "IANA Time Zone",
"pattern": "^\\w+\\/\\w+?",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "timezone",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"timezone"
]
},
"jobTitle": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Job Title",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "jobTitle",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"title"
]
},
"mfaDeviceEmail1": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Email 1",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "mfaDeviceEmail1",
"caseSensitive": false,
"minLength": 1,
"referenceAttribute": [
"work_email"
]
},
"externalID": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "External ID",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "externalID",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"external_id"
]
},
"profileImage": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Profile Image",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "profileImage",
"caseSensitive": false,
"referenceAttribute": [
"photo_url"
]
},
"locale": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Locale",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "locale",
"caseSensitive": false,
"minLength": 0,
"defaultValue": "en-US",
"referenceAttribute": [
""
]
},
"enabled": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": true,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Enabled",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "enabled",
"defaultValue": true
},
"mfaDeviceEmail3": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Email 3",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "mfaDeviceEmail3",
"caseSensitive": false,
"minLength": 1,
"referenceAttribute": [
""
]
},
"mfaDeviceEmail2": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "MFA Device Email 2",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "mfaDeviceEmail2",
"caseSensitive": false,
"minLength": 1,
"referenceAttribute": [
""
]
},
"honorificSuffix": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Honorific Suffix",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "honorificSuffix",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"name_suffix"
]
},
"accountID": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Account ID",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "accountID",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
""
]
},
"password": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": false,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": true,
"displayName": "Password",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "password",
"caseSensitive": true,
"minLength": 0,
"referenceAttribute": [
"password"
]
},
"officeLocation": {
"type": "STRING",
"attributeType": "STRING",
"creatable": true,
"updateable": true,
"nillable": true,
"unique": false,
"displayName": "An optional property that specifies the display name of the attribute.",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": true,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"key": "officeLocation",
"caseSensitive": false,
"maxLength": 256,
"minLength": 1
},
"nickname": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Nickname",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "nickname",
"caseSensitive": false,
"maxLength": 256,
"minLength": 0,
"referenceAttribute": [
"nickname"
]
},
"stateRegion": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "State / Region",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "stateRegion",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"work_region"
]
},
"mfaEnabled": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": true,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "MFA Enabled",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaEnabled",
"defaultValue": false,
"referenceAttribute": [
""
]
},
"id": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": false,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Id",
"requiredOnUpdate": true,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "id",
"caseSensitive": false,
"maxLength": 255,
"minLength": 0,
"referenceAttribute": [
"id"
]
},
"populationID": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"picklistValues": [
"cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a||Finance and Accounting"
],
"sensitive": false,
"displayName": "Population ID",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "populationID",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"email": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Email",
"requiredOnUpdate": true,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "email",
"caseSensitive": false,
"minLength": 1,
"referenceAttribute": [
"work_email"
]
},
"authoritativeIdp": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"picklistValues": [
"||PingOne"
],
"sensitive": false,
"displayName": "Authoritative IDP",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "authoritativeIdp",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"mfaDeviceSms3": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device SMS 3",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceSms3",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"fullName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Full Name",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "fullName",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"formatted_name"
]
},
"honorificPrefix": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Honorific Prefix",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "honorificPrefix",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"name_prefix"
]
},
"mfaDeviceSms1": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device SMS 1",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceSms1",
"caseSensitive": false,
"referenceAttribute": [
"mobile_phone"
]
},
"mfaDeviceSms2": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "MFA Device SMS 2",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mfaDeviceSms2",
"caseSensitive": false,
"referenceAttribute": [
""
]
},
"firstName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "First Name",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "firstName",
"caseSensitive": false,
"maxLength": 256,
"minLength": 0,
"referenceAttribute": [
"given_name"
]
},
"primaryPhone": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Primary Phone",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "primaryPhone",
"caseSensitive": false,
"referenceAttribute": [
"work_phone"
]
},
"mobilePhone": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mobile Phone",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"pattern": "\"^+[0-9]{1,3}.[0-9]{4,14}(?:x[0-9]{1,8})?$\"",
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "mobilePhone",
"caseSensitive": false,
"referenceAttribute": [
"mobile_phone"
]
},
"streetAddress": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Street Address",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "streetAddress",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
"work_street_address"
]
},
"middleName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Middle Name",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "middleName",
"caseSensitive": false,
"maxLength": 256,
"minLength": 0,
"referenceAttribute": [
"middle_name"
]
},
"userType": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "User Type",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "userType",
"caseSensitive": false,
"minLength": 0,
"referenceAttribute": [
""
]
},
"forceChangePassword": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"distinguishingAttribute": false,
"creatable": true,
"updateable": false,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Force Change Password",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "forceChangePassword",
"defaultValue": false,
"referenceAttribute": [
""
]
},
"username": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Username",
"requiredOnUpdate": true,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "username",
"caseSensitive": false,
"maxLength": 128,
"minLength": 1,
"referenceAttribute": [
"username"
]
}
},
"groupAttributes": {
"name": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Name",
"requiredOnUpdate": true,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "name",
"caseSensitive": false,
"maxLength": 256,
"minLength": 1
},
"description": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Description",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 0,
"ordered": false,
"key": "description",
"caseSensitive": false,
"maxLength": 1024,
"minLength": 1
},
"id": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": false,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Id",
"requiredOnUpdate": true,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "id",
"caseSensitive": false,
"maxLength": 255,
"minLength": 0,
"referenceAttribute": [
"id"
]
}
}
},
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/PingOne"
}
}
}