Identity Propagation Store Metadata (SalesforceContacts)
POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts
The POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts endpoint returns metadata from the specified SalesforceContacts identity store.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Refer to the Propagation store SalesforceContacts 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 |
|
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/SalesforceContacts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts")
{
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"": ""my.salesforce.com""," + "\n" +
@" ""CLIENT_ID"": ""yourClientID""," + "\n" +
@" ""CLIENT_SECRET"": ""yourClientSecret""," + "\n" +
@" ""OAUTH_ACCESS_TOKEN"": ""yourAccessToken""," + "\n" +
@" ""OAUTH_REFRESH_TOKEN"": ""yourRefreshToken""" + "\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/SalesforceContacts"
method := "POST"
payload := strings.NewReader(`{
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
}`)
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/SalesforceContacts HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"SALESFORCE_DOMAIN\": \"my.salesforce.com\",\n \"CLIENT_ID\": \"yourClientID\",\n \"CLIENT_SECRET\": \"yourClientSecret\",\n \"OAUTH_ACCESS_TOKEN\": \"yourAccessToken\",\n \"OAUTH_REFRESH_TOKEN\": \"yourRefreshToken\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts")
.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/SalesforceContacts",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
})
};
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/SalesforceContacts"
payload = json.dumps({
"SALESFORCE_DOMAIN": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
})
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/SalesforceContacts');
$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": "my.salesforce.com",\n "CLIENT_ID": "yourClientID",\n "CLIENT_SECRET": "yourClientSecret",\n "OAUTH_ACCESS_TOKEN": "yourAccessToken",\n "OAUTH_REFRESH_TOKEN": "yourRefreshToken"\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/SalesforceContacts")
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": "my.salesforce.com",
"CLIENT_ID": "yourClientID",
"CLIENT_SECRET": "yourClientSecret",
"OAUTH_ACCESS_TOKEN": "yourAccessToken",
"OAUTH_REFRESH_TOKEN": "yourRefreshToken"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"SALESFORCE_DOMAIN\": \"my.salesforce.com\",\n \"CLIENT_ID\": \"yourClientID\",\n \"CLIENT_SECRET\": \"yourClientSecret\",\n \"OAUTH_ACCESS_TOKEN\": \"yourAccessToken\",\n \"OAUTH_REFRESH_TOKEN\": \"yourRefreshToken\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts")!,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": "SalesforceContacts",
"version": "1.0",
"displayName": "Salesforce Contacts 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": "RECORD_TYPE",
"displayLabel": "Salesforce Record Type",
"description": "Salesforce Record Type",
"required": true,
"sensitive": false
},
{
"key": "CREATE_NEW_USERS",
"displayLabel": "Record Create",
"description": "Record Create Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "UPDATE_NEW_USERS",
"displayLabel": "Record Update",
"description": "Record Update Enabled",
"required": false,
"typeBoolean": true,
"sensitive": false
},
{
"key": "DELETE_USERS",
"displayLabel": "Record Delete",
"description": "Record Delete Enabled",
"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": "CHECK_CONNECTION",
"maxResources": 1
},
{
"type": "GET_ATTRIBUTES",
"maxResources": 1
},
{
"type": "GET_USERS",
"maxResources": 1
},
{
"type": "CREATE_USERS",
"maxResources": 1
},
{
"type": "UPDATE_USERS",
"maxResources": 1
},
{
"type": "DELETE_USERS",
"maxResources": 1
},
{
"type": "GET_CONNECTION_PROFILES",
"maxResources": 1
},
{
"type": "GET_INFO",
"maxResources": 1
}
],
"userAttributes": {
"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"
]
},
"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"
]
},
"OtherPostalCode": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Other Postal Code",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "OtherPostalCode",
"caseSensitive": false,
"maxLength": 20,
"minLength": 0,
"referenceAttribute": [
"other_postal_code"
]
},
"MailingCountry": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mailing Country",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MailingCountry",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"work_country"
]
},
"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"
]
},
"MailingCity": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mailing City",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MailingCity",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"work_city"
]
},
"OtherStreet": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Other Street",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "OtherStreet",
"caseSensitive": false,
"maxLength": 255,
"minLength": 0,
"referenceAttribute": [
"other_street_address"
]
},
"OtherState": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Other State",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "OtherState",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"other_region"
]
},
"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"
]
},
"MailingState": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mailing State",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MailingState",
"caseSensitive": false,
"maxLength": 80,
"minLength": 0,
"referenceAttribute": [
"work_region"
]
},
"OtherCity": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Other City",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "OtherCity",
"caseSensitive": false,
"maxLength": 40,
"minLength": 0,
"referenceAttribute": [
"other_city"
]
},
"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"
]
},
"MailingPostalCode": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mailing Postal Code",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MailingPostalCode",
"caseSensitive": false,
"maxLength": 20,
"minLength": 0,
"referenceAttribute": [
"work_postal_code"
]
},
"OtherCountry": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Other Country",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "OtherCountry",
"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"
]
},
"MailingStreet": {
"type": "STRING",
"attributeType": "STRING",
"distinguishingAttribute": false,
"creatable": true,
"updateable": true,
"defaultedOnCreate": false,
"nillable": true,
"unique": false,
"sensitive": false,
"displayName": "Mailing Street",
"requiredOnUpdate": false,
"requiredOnCreate": false,
"derived": false,
"maxNumberOfValues": 1,
"minNumberOfValues": 1,
"ordered": false,
"key": "MailingStreet",
"caseSensitive": false,
"maxLength": 255,
"minLength": 0,
"referenceAttribute": [
"work_street_address"
]
}
},
"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/SalesforceContacts"
}
}
}