Authentication configuration

Supported authentication types

The authentication configuration that you select determines how Experience Platform authenticates to your destination, in the Platform UI.

Adobe Experience Platform Destination SDK supports several authentication types:

You can configure the authentication information for your destination via the customerAuthenticationConfigurations parameters of the /destinations endpoint.

Refer to the following sections for authentication configuration details for each type of destination:

Bearer authentication

Bearer authentication is supported for streaming destinations in Experience Platform.

To set up bearer type authentication for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"BEARER"
   }
]

Amazon S3 authentication

Amazon S3 authentication is supported for file-based destinations in Experience Platform.

To set up Amazon S3 authentication for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"S3"
   }
]

Azure Blob Storage

Azure Blob Storage authentication is supported for file-based destinations in Experience Platform.

To set up Azure Blob authentication for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"AZURE_CONNECTION_STRING"
   }
]

Azure Data Lake Storage

Azure Data Lake Storage authentication is supported for file-based destinations in Experience Platform.

To set up Azure Data Lake Storage (ADLS) authentication for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"AZURE_SERVICE_PRINCIPAL"
   }
]

Google Cloud Storage

Google Cloud Storage authentication is supported for file-based destinations in Experience Platform.

"customerAuthenticationConfigurations":[
   {
      "authType":"GOOGLE_CLOUD_STORAGE"
   }
]

SFTP authentication with SSH key

SFTP authentication with SSH key is supported for file-based destinations in Experience Platform.

To set up SFTP authentication with SSH key for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"SFTP_WITH_SSH_KEY"
   }
]

SFTP authentication with password

SFTP authentication with password is supported for file-based destinations in Experience Platform.

To set up SFTP authentication with password for your destination, configure the customerAuthenticationConfigurations parameter in the /destinations endpoint as shown below:

"customerAuthenticationConfigurations":[
   {
      "authType":"SFTP_WITH_PASSWORD"
   }
]

OAuth 2 authentication

OAuth 2 authentication is supported for streaming destinations in Experience Platform.

For information how to set up the various supported OAuth 2 flows, as well as for custom OAuth 2 support, read the Destination SDK documentation on OAuth 2 authentication.

When to use the /credentials API endpoint

IMPORTANT

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

The /credentials API endpoint is provided to destination developers for the cases when there is a global authentication system between Adobe and your destination and Platform customers do not need to provide any authentication credentials to connect to your destination.

In this case, you must create a credentials object by using the /credentials API endpoint. You must also select PLATFORM_AUTHENTICATION in the destination configuration. Read Credentials API endpoint operations for a complete list of operations that you can perform on the /credentials endpoint.

On this page