Identity Propagation Store Metadata (Salesforce)
POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce
The POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce endpoint returns metadata from the specified Salesforce identity store.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Refer to the Propagation store Salesforce 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 |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
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/Salesforce' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce")
{
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" +
@" ""SALESFORCE_DOMAIN"": ""mySalesforceDomain.salesforce.com""," + "\n" +
@" ""CLIENT_ID"": ""salesforceClientID""," + "\n" +
@" ""CLIENT_SECRET"": ""salesforceClientSecret""," + "\n" +
@" ""OAUTH_ACCESS_TOKEN"": ""token""," + "\n" +
@" ""OAUTH_REFRESH_TOKEN"": ""token""" + "\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/Salesforce"
method := "POST"
payload := strings.NewReader(`{
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
}`)
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/Salesforce HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"SALESFORCE_DOMAIN\": \"mySalesforceDomain.salesforce.com\",\n \"CLIENT_ID\": \"salesforceClientID\",\n \"CLIENT_SECRET\": \"salesforceClientSecret\",\n \"OAUTH_ACCESS_TOKEN\": \"token\",\n \"OAUTH_REFRESH_TOKEN\": \"token\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce")
.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/Salesforce",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
})
};
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/Salesforce"
payload = json.dumps({
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
})
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/Salesforce');
$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 "SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",\n "CLIENT_ID": "salesforceClientID",\n "CLIENT_SECRET": "salesforceClientSecret",\n "OAUTH_ACCESS_TOKEN": "token",\n "OAUTH_REFRESH_TOKEN": "token"\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/Salesforce")
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({
"SALESFORCE_DOMAIN": "mySalesforceDomain.salesforce.com",
"CLIENT_ID": "salesforceClientID",
"CLIENT_SECRET": "salesforceClientSecret",
"OAUTH_ACCESS_TOKEN": "token",
"OAUTH_REFRESH_TOKEN": "token"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"SALESFORCE_DOMAIN\": \"mySalesforceDomain.salesforce.com\",\n \"CLIENT_ID\": \"salesforceClientID\",\n \"CLIENT_SECRET\": \"salesforceClientSecret\",\n \"OAUTH_ACCESS_TOKEN\": \"token\",\n \"OAUTH_REFRESH_TOKEN\": \"token\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/Salesforce")!,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": "http://res.cloudinary.com/ping-identity/image/upload/c_scale,w_1000/v1472216762/salesforce.png",
"key": "Salesforce",
"version": "7.0",
"displayName": "Salesforce Connector",
"identityProvider": true,
"baseURLRequired": false,
"connectionInformationRequired": false
},
"connectionProfiles": [
{
"name": "OAuth Bearer Token",
"description": "Authentication Scheme using the OAuth Bearer Token Standard",
"connectionAttributes": [
{
"key": "OAUTH_ACCESS_TOKEN",
"displayLabel": "OAuth Access Token",
"description": "OAuth Access Token",
"required": true,
"sensitive": true
},
{
"key": "OAUTH_REFRESH_TOKEN",
"displayLabel": "OAuth Refresh Token",
"description": "OAuth Refresh Token",
"required": true,
"sensitive": true
},
{
"key": "CLIENT_ID",
"displayLabel": "Client Id",
"description": "Client Id",
"required": true,
"sensitive": false
},
{
"key": "CLIENT_SECRET",
"displayLabel": "Client Secret",
"description": "Client Secret",
"required": true,
"sensitive": true
},
{
"key": "PERMISSION_SET_MANAGEMENT",
"displayLabel": "Permission Set Management",
"description": "Permission Set Management",
"required": false,
"sensitive": false
},
{
"key": "ACCOUNT_ID",
"displayLabel": "Account ID",
"description": "Account ID",
"required": false,
"sensitive": false
},
{
"key": "PROFILE_ID",
"displayLabel": "Profile ID",
"description": "Profile ID",
"required": false,
"sensitive": false
},
{
"key": "ENABLE_COMMUNITIES",
"displayLabel": "Enable Communities",
"description": "Enable Communities",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "CREATE_NEW_USERS",
"displayLabel": "User Create",
"description": "User Create Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "UPDATE_NEW_USERS",
"displayLabel": "User Update",
"description": "User Update Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "DISABLE_USERS",
"displayLabel": "User Disable",
"description": "User Disable Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "PROVISION_DISABLED_USERS",
"displayLabel": "Provision Disabled Users",
"description": "Provision Disabled User Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "FREEZE_USER_FLAG",
"displayLabel": "Freeze Users Instead of Disable",
"description": "Freeze Users Instead of Disable",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "SALESFORCE_DOMAIN",
"displayLabel": "Salesforce Domain",
"description": "Salesforce Domain",
"required": true,
"sensitive": false
}
],
"specUrl": "http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01",
"documentationUrl": "",
"primary": false
}
],
"attributeMetadata": {
"capabilities": [
{
"type": "GET_GROUPS",
"maxResources": 1
},
{
"type": "CREATE_USERS",
"maxResources": 1
},
{
"type": "DELETE_GROUPS",
"maxResources": 1
},
{
"type": "GET_USERS",
"maxResources": 1
},
{
"type": "UPDATE_USERS",
"maxResources": 1
},
{
"type": "DELETE_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "GET_INFO",
"maxResources": 1
},
{
"type": "CREATE_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "UPDATE_GROUPS",
"maxResources": 1
},
{
"type": "GET_ATTRIBUTES",
"maxResources": 1
},
{
"type": "GET_CONNECTION_PROFILES",
"maxResources": 1
},
{
"type": "CREATE_GROUPS",
"maxResources": 1
},
{
"type": "GET_ALL_MEMBERSHIPS",
"maxResources": 1
},
{
"type": "GET_MEMBERS_OF_GROUP",
"maxResources": 1
},
{
"type": "GET_ALL_GROUPS",
"maxResources": 1
},
{
"type": "CHECK_CONNECTION",
"maxResources": 1
},
{
"type": "GET_MEMBERSHIPS",
"maxResources": 1
}
],
"userAttributes": {
"ProfileId": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Profile Id",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "ProfileId",
"caseSensitive": false,
"maxLength": 18,
"minLength": 1
},
"Email": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Email",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Email",
"caseSensitive": true,
"maxLength": 128,
"minLength": 1,
"referenceAttribute": [
"work_email"
]
},
"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": 1,
"ordered": false,
"key": "AccountId"
},
"TimeZoneSidKey": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"picklistValues": [
"Pacific/Kiritimati",
"Pacific/Enderbury",
"Pacific/Tongatapu",
"Pacific/Chatham",
"Asia/Kamchatka",
"Pacific/Auckland",
"Pacific/Fiji",
"Pacific/Guadalcanal",
"Pacific/Norfolk",
"Australia/Lord_Howe",
"Australia/Brisbane",
"Australia/Sydney",
"Australia/Adelaide",
"Australia/Darwin",
"Asia/Seoul",
"Asia/Tokyo",
"Asia/Hong_Kong",
"Asia/Kuala_Lumpur",
"Asia/Manila",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Taipei",
"Australia/Perth",
"Asia/Bangkok",
"Asia/Ho_Chi_Minh",
"Asia/Jakarta",
"Asia/Rangoon",
"Asia/Dhaka",
"Asia/Kathmandu",
"Asia/Colombo",
"Asia/Kolkata",
"Asia/Baku",
"Asia/Karachi",
"Asia/Tashkent",
"Asia/Yekaterinburg",
"Asia/Kabul",
"Asia/Tehran",
"Asia/Dubai",
"Asia/Tbilisi",
"Asia/Yerevan",
"Africa/Nairobi",
"Asia/Baghdad",
"Asia/Beirut",
"Asia/Jerusalem",
"Asia/Kuwait",
"Asia/Riyadh",
"Europe/Athens",
"Europe/Bucharest",
"Europe/Helsinki",
"Europe/Istanbul",
"Europe/Minsk",
"Europe/Moscow",
"Africa/Cairo",
"Africa/Johannesburg",
"Europe/Amsterdam",
"Europe/Berlin",
"Europe/Brussels",
"Europe/Paris",
"Europe/Prague",
"Europe/Rome",
"Africa/Algiers",
"Africa/Casablanca",
"Europe/Dublin",
"Europe/Lisbon",
"Europe/London",
"America/Scoresbysund",
"Atlantic/Azores",
"GMT",
"Atlantic/Cape_Verde",
"Atlantic/South_Georgia",
"America/St_Johns",
"America/Argentina/Buenos_Aires",
"America/Halifax",
"America/Santiago",
"America/Sao_Paulo",
"Atlantic/Bermuda",
"America/Indiana/Indianapolis",
"America/New_York",
"America/Puerto_Rico",
"America/Caracas",
"America/Bogota",
"America/Chicago",
"America/Lima",
"America/Mexico_City",
"America/Panama",
"America/Denver",
"America/El_Salvador",
"America/Mazatlan",
"America/Los_Angeles",
"America/Phoenix",
"America/Tijuana",
"America/Anchorage",
"Pacific/Pitcairn",
"America/Adak",
"Pacific/Gambier",
"Pacific/Marquesas",
"Pacific/Honolulu",
"Pacific/Niue",
"Pacific/Pago_Pago"
],
"sensitive": false,
"displayName": "Time Zone Sid Key",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "TimeZoneSidKey",
"caseSensitive": false,
"maxLength": 40,
"minLength": 1,
"defaultValue": "America/New_York"
},
"LanguageLocaleKey": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"picklistValues": [
"en_US",
"de",
"es",
"fr",
"it",
"ja",
"sv",
"ko",
"zh_TW",
"zh_CN",
"pt_BR",
"nl_NL",
"da",
"th",
"fi",
"ru",
"es_MX",
"no"
],
"sensitive": false,
"displayName": "Language Locale Key",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "LanguageLocaleKey",
"caseSensitive": false,
"maxLength": 40,
"minLength": 1,
"defaultValue": "en_US"
},
"UserRoleId": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "User Role Id",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "UserRoleId",
"caseSensitive": false,
"maxLength": 18,
"minLength": 0
},
"IsActive": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Active",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "IsActive",
"referenceAttribute": [
"active"
]
},
"PostalCode": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Postal Code",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "PostalCode",
"caseSensitive": false,
"maxLength": 20,
"minLength": 0,
"referenceAttribute": [
"work_postal_code"
]
},
"ContactId": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Contact Id",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "ContactId"
},
"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,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MobilePhone",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"mobile_phone"
]
},
"CompanyName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Company Name",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "CompanyName",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"organization"
]
},
"Department": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Department",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Department",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"department"
]
},
"CommunityNickname": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Community Nickname",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "CommunityNickname",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0
},
"Phone": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Phone",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Phone",
"caseSensitive": false,
"maxLength": 40,
"minLength": 1,
"referenceAttribute": [
"work_phone"
]
},
"Street": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Street",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Street",
"caseSensitive": false,
"maxLength": 255,
"minLength": 0,
"referenceAttribute": [
"work_street_address"
]
},
"FederationIdentifier": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Federation Identifier",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "FederationIdentifier",
"caseSensitive": false,
"maxLength": 512,
"minLength": 0
},
"Division": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Division",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Division",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"division"
]
},
"LocaleSidKey": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"picklistValues": [
"sq_AL",
"ar_DZ",
"ar_BH",
"ar_EG",
"ar_IQ",
"ar_JO",
"ar_KW",
"ar_LB",
"ar_LY",
"ar_MA",
"ar_OM",
"ar_QA",
"ar_SA",
"ar_SD",
"ar_SY",
"ar_TN",
"ar_AE",
"ar_YE",
"hy_AM",
"az_AZ",
"eu_ES",
"be_BY",
"bn_BD",
"bs_BA",
"bg_BG",
"my_MM",
"ca_ES",
"zh_CN_PINYIN",
"zh_CN_STROKE",
"zh_CN",
"zh_HK_STROKE",
"zh_HK",
"zh_MO",
"zh_SG",
"zh_TW_STROKE",
"zh_TW",
"hr_HR",
"cs_CZ",
"da_DK",
"nl_AW",
"nl_BE",
"nl_NL",
"nl_SR",
"dz_BT",
"en_AG",
"en_AU",
"en_BS",
"en_BB",
"en_BZ",
"en_BM",
"en_BW",
"en_CM",
"en_CA",
"en_KY",
"en_ER",
"en_FK",
"en_FJ",
"en_GM",
"en_GH",
"en_GI",
"en_GY",
"en_HK",
"en_IN",
"en_ID",
"en_IE",
"en_JM",
"en_KE",
"en_LR",
"en_MG",
"en_MW",
"en_MY",
"en_MU",
"en_NA",
"en_NZ",
"en_NG",
"en_PK",
"en_PG",
"en_PH",
"en_RW",
"en_WS",
"en_SC",
"en_SL",
"en_SG",
"en_SX",
"en_SB",
"en_ZA",
"en_SH",
"en_SZ",
"en_TZ",
"en_TO",
"en_TT",
"en_UG",
"en_GB",
"en_US",
"en_VU",
"et_EE",
"fi_FI",
"fr_BE",
"fr_CA",
"fr_KM",
"fr_FR",
"fr_GN",
"fr_HT",
"fr_LU",
"fr_MR",
"fr_MC",
"fr_CH",
"fr_WF",
"ka_GE",
"de_AT",
"de_DE",
"de_LU",
"de_CH",
"el_GR",
"iw_IL",
"hi_IN",
"hu_HU",
"is_IS",
"in_ID",
"ga_IE",
"it_IT",
"it_CH",
"ja_JP",
"kk_KZ",
"km_KH",
"ko_KP",
"ko_KR",
"ky_KG",
"lo_LA",
"lv_LV",
"lt_LT",
"lu_CD",
"lb_LU",
"mk_MK",
"ms_BN",
"ms_MY",
"mt_MT",
"sh_ME",
"ne_NP",
"no_NO",
"ps_AF",
"fa_IR",
"pl_PL",
"pt_AO",
"pt_BR",
"pt_CV",
"pt_MZ",
"pt_PT",
"pt_ST",
"ro_MD",
"ro_RO",
"rm_CH",
"rn_BI",
"ru_RU",
"sr_BA",
"sh_BA",
"sh_CS",
"sr_CS",
"sr_RS",
"sk_SK",
"sl_SI",
"so_DJ",
"so_SO",
"es_AR",
"es_BO",
"es_CL",
"es_CO",
"es_CR",
"es_CU",
"es_DO",
"es_EC",
"es_SV",
"es_GT",
"es_HN",
"es_MX",
"es_NI",
"es_PA",
"es_PY",
"es_PE",
"es_PR",
"es_ES",
"es_US",
"es_UY",
"es_VE",
"sv_SE",
"tl_PH",
"tg_TJ",
"ta_IN",
"ta_LK",
"th_TH",
"ti_ET",
"tr_TR",
"uk_UA",
"ur_PK",
"uz_LATN_UZ",
"vi_VN",
"cy_GB",
"yo_BJ"
],
"sensitive": false,
"displayName": "Locale Sid Key",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "LocaleSidKey",
"caseSensitive": false,
"maxLength": 40,
"minLength": 1,
"defaultValue": "en_US"
},
"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": 1,
"ordered": false,
"key": "FirstName",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"given_name"
]
},
"Title": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Title",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Title",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"title"
]
},
"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": 1,
"ordered": false,
"key": "City",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"work_city"
]
},
"EmailEncodingKey": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"picklistValues": [
"UTF-8",
"ISO-8859-1",
"Shift_JIS",
"ISO-2022-JP",
"EUC-JP",
"ks_c_5601-1987",
"Big5",
"GB2312",
"Big5-HKSCS",
"x-SJIS_0213"
],
"sensitive": false,
"displayName": "Email Encoding Key",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "EmailEncodingKey",
"caseSensitive": false,
"maxLength": 40,
"minLength": 1,
"defaultValue": "UTF-8"
},
"Frozen": {
"type": "BOOLEAN",
"attributeType": "BOOLEAN",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": true,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Frozen",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Frozen",
"defaultValue": false
},
"PermissionSets": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Permission Sets",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 2147483647,
"minNumberOfValues": 1,
"ordered": false,
"key": "PermissionSets"
},
"Extension": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Extension",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Extension",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0
},
"Username": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": true,
"sensitive": false,
"displayName": "Username",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Username",
"caseSensitive": false,
"maxLength": 80,
"minLength": 1,
"referenceAttribute": [
"work_email",
"username"
]
},
"Alias": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Alias",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Alias",
"caseSensitive": false,
"maxLength": 8,
"minLength": 1,
"referenceAttribute": [
"username"
]
},
"State": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "State",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "State",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"work_region"
]
},
"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,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Country",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"other_country"
]
},
"LastName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "Last Name",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "LastName",
"caseSensitive": false,
"maxLength": 80,
"minLength": 1,
"referenceAttribute": [
"family_name"
]
},
"Fax": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Fax",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "Fax",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"fax_phone"
]
}
},
"groupAttributes": {
"GroupName": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": true,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": false,
"unique": false,
"sensitive": false,
"displayName": "GroupName",
"requiredOnUpdate": false,
"requiredOnCreate": true,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "GroupName",
"caseSensitive": true,
"maxLength": 40,
"minLength": 1,
"referenceAttribute": [
"display_name"
]
}
}
},
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/storeMetadata/Salesforce"
}
}
}