Qodex.ai

Identity Propagation Store Metadata (SalesforceContacts)

POST {{apiPath}}/environments/{{envID}}/propagation/storeMetadata/SalesforceContacts

The POST /environments/{{envID}}/propagation/storeMetadata/SalesforceContacts endpoint returns metadata from the specified SalesforceContacts identity store.

Prerequisites

See 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.

PropertyTypeRequired?
ACCOUNT_IDStringOptional
CLIENT_IDStringRequired
CLIENT_SECRETStringRequired
CREATE_NEW_USERS (Deprecated)BooleanOptional
CREATE_USERSBooleanOptional
DISABLE_USERSBooleanOptional
ENABLE_COMMUNITIESBooleanOptional
FREEZE_USER_FLAGBooleanOptional
OAUTH_ACCESS_TOKENStringRequired
OAUTH_REFRESH_TOKENStringRequired
PERMISSION_SET_MANAGEMENTStringOptional
PROFILE_IDStringOptional
PROVISION_DISABLED_USERSBooleanOptional
RECORD_TYPEStringRequired
SALESFORCE_DOMAINStringRequired
UPDATE_NEW_USERS (Deprecated)BooleanOptional
UPDATE_USERSBooleanOptional

Request Body

{"SALESFORCE_DOMAIN"=>"my.salesforce.com", "CLIENT_ID"=>"yourClientID", "CLIENT_SECRET"=>"yourClientSecret", "OAUTH_ACCESS_TOKEN"=>"yourAccessToken", "OAUTH_REFRESH_TOKEN"=>"yourRefreshToken"}

RESPONSES

status: 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"}}}