API endpoint: platform.adobe.io/data/core/activation/authoring/credentials
This page exemplifies the API request and payload that you can use to update an existing 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 update an existing credential configuration by making a PUT
request to the /authoring/credentials
endpoint with the updated payload.
To obtain an existing credential configuration and its corresponding {INSTANCE_ID}
, see the article about retrieving a credential configuration.
API format
PUT /authoring/credentials/{INSTANCE_ID}
Parameter | Description |
---|---|
{INSTANCE_ID} |
The ID of the credential configuration that you want to update. To obtain an existing credential configuration and its corresponding {INSTANCE_ID} , see Retrieve a credential configuration. |
The following requests update existing credential configurations, defined by the parameters provided in the payload.
Select each tab below to view the corresponding payload.
Update a basic credential configuration
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"basicAuthentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
Parameter | Type | Description |
---|---|---|
url |
String | URL of authorization provider |
username |
String | Credentials configuration login username |
password |
String | Credentials configuration login password |
A successful response returns HTTP status 200 with the details of your updated credential configuration.
Update an Amazon S3 credential configuration
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
}
Parameter | Type | Description |
---|---|---|
accessId |
String | Amazon S3 access ID |
secretKey |
String | Amazon S3 secret key |
A successful response returns HTTP status 200 with the details of your updated credential configuration.
Update an SSH credential configuration
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"sshAuthentication":{
"username":"string",
"sshKey":"string"
}
}
Parameter | Type | Description |
---|---|---|
username |
String | Credentials configuration login username |
sshKey |
String | SSH key for SFTP with SSH authentication |
A successful response returns HTTP status 200 with the details of your updated credential configuration.
Update an Azure Data Lake Storage credential configuration
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureAuthentication":{
"url":"string",
"tenant":"string",
"servicePrincipalId":"string",
"servicePrincipalKey":"string"
}
}
Parameter | Type | Description |
---|---|---|
url |
String | URL of authorization provider |
tenant |
String | Azure Data Lake Storage tenant |
servicePrincipalId |
String | Azure Service Principal ID for Azure Data Lake Storage |
servicePrincipalKey |
String | Azure Service Principal Key for Azure Data Lake Storage |
A successful response returns HTTP status 200 with the details of your updated credential configuration.
Update an Azure Blob credential configuration
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureConnectionStringAuthentication":{
"connectionString":"string"
}
}
Parameter | Type | Description |
---|---|---|
connectionString |
String | Azure Blob Storage connection string |
A successful response returns HTTP status 200 with the details of your updated credential configuration.
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 update a credential configuration 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.