API endpoint: platform.adobe.io/data/core/activation/authoring/credentials
This page exemplifies the API request and payload that you can use to retrieve a credential configuration using the /authoring/credentials
API endpoint.
/credentials
API endpointIn most cases, you do not need to use the /credentials
API endpoint. Instead, you can configure the authentication information for your destination via the customerAuthenticationConfigurations
parameters of the /destinations
endpoint.
Read Customer authentication configuration for detailed information on the supported authentication types.
Use this API endpoint to create a credential configuration only if there is a global authentication system between Adobe and your destination platform, and the Platform customer does not need to provide any authentication credentials to connect to your destination. In this case, you must create a credential configuration using the /credentials
API endpoint.
When using a global authentication system, you must set "authenticationRule":"PLATFORM_AUTHENTICATION"
in the destination delivery configuration, when creating a new destination configuration.
All parameter names and values supported by Destination SDK are case sensitive. To avoid case sensitivity errors, please use the parameters names and values exactly as shown in the documentation.
Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.
You can retrieve an existing credential configuration by making a GET
request to the /authoring/credentials
endpoint.
API format
Use the following API format to retrieve all credential configurations for your account.
GET /authoring/credentials
Use the following API format to retrieve a specific credential configuration, defined by the {INSTANCE_ID}
parameter.
GET /authoring/credentials/{INSTANCE_ID}
The following two requests retrieve all credentials configurations for your IMS Organization, or a specific credential configuration, depending on whether you pass the INSTANCE_ID
parameter in the request.
Select each tab below to view the corresponding payload.
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
A successful response returns HTTP status 200 with a list of credential configurations that you have access to, based on the IMS Org ID and sandbox name that you used. One instanceId
corresponds to one credential configuration.
{
"instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
"createdDate":"2021-06-07T06:41:48.641943Z",
"lastModifiedDate":"2021-06-07T06:41:48.641943Z",
"type":"s3Authentication",
"name":"yourdestination",
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
},
{
"instanceId":"a25bffa0-3127-4030-895d-1d1236bb3680",
"createdDate":"2022-06-07T06:41:48.641943Z",
"lastModifiedDate":"2022-08-07T06:41:48.641943Z",
"type":"basic",
"name":"yourdestination",
"s3Authentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Parameter | Description |
---|---|
{INSTANCE_ID} |
The ID of the credential configuration you want to retrieve. |
A successful response returns HTTP status 200 with the details of the credential configuration corresponding to the instanceId
provided on the request.
{
"instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
"createdDate":"2021-06-07T06:41:48.641943Z",
"lastModifiedDate":"2021-06-07T06:41:48.641943Z",
"type":"s3Authentication",
"name":"yourdestination",
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
}
Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.
After reading this document, you now know how to retrieve details about your credential configurations using the /authoring/credentials
API endpoint. Read how to use Destination SDK to configure your destination to understand where this step fits into the process of configuring your destination.