Retrieve a credential configuration

This page exemplifies the API request and payload that you can use to retrieve a credential configuration using the /authoring/credentials API endpoint.

When to use the /credentials API endpoint when-to-use

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 Experience 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. Then, you must create a credentials configuration and pass the credential object’s ID in the authenticationId parameter in the destination delivery configuration.

Getting started with credentials API operations get-started

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.

Retrieve a credential configuration retrieve

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}' \

{
   "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}'

{
   "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"
   }
}

API error handling error-handling

Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Experience Platform troubleshooting guide.

Next steps next-steps

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.