Adobe Experience Platform Query Service allows you to connect with external clients. You can connect to these external clients by using either expiring credentials or non-expiring credentials.
You can use expiring credentials to quickly set up a connection to an external client.
The Expiring credentials section provides the following information:
To change the session life for your expiring credentials connection to Query Service, navigate to the Admin Console and select the following on screen options: Settings > Privacy and Security > Authentication Settings > Advanced settings > Max session life.
See the Adobe Help documentation for more information on the Advanced settings offered by Admin console.
You can use non-expiring credentials to set up a more permanent connection to an external client.
Non-expiring credentials have the following limitations:
{technicalAccountId}:{credential}
. More information can be found in the Generate credentials section.Before you can generate non-expiring credentials, you must complete the following steps in Adobe Admin Console:
To learn more about how to assign permissions, please read the documentation on access control.
All the required permissions are now configured in Adobe Developer Console for the user to use the expiring credentials feature.
To create a set of non-expiring credentials, return to the Platform UI and select Queries from the left navigation to access the Queries workspace. Next, select the Credentials tab followed by Generate credentials.
A dialog appears that allows you to generate credentials. To create non-expiring credentials, you must provide the following details:
Once you have provided all the required details, select Generate credentials to generate your credentials.
When Generate credentials is selected, a configuration JSON file is downloaded to your local machine. Since Adobe does not record the generated credentials, you must securely store the downloaded file and keep a record of the credential.
Additionally, if the credentials are not used for 90 days, the credentials will be expunged.
The configuration JSON file contains information such as technical account name, technical account ID, and credential. It is provided in the following format.
{"technicalAccountName":"9F0A21EE-B8F3-4165-9871-846D3C8BC49E@TECHACCT.ADOBE.COM","credential":"3d184fa9e0b94f33a7781905c05203ee","technicalAccountId":"4F2611B8613AA3670A495E55"}
After you have saved your generated credentials, select Close. You can now see a list of all your non-expiring credentials.
You can either edit or delete your non-expiring credentials. To edit a non-expiring credential, select the pencil icon (). To delete a non-expiring credential, select the delete icon (
).
When editing a non-expiring credential, a modal appears. You can provide the following details to update:
Once you have provided all the required details, select Update account to complete the update to your credentials.
You can use either the expiring or non-expiring credentials to connect with external clients, such as Aqua Data Studio, Looker, or Power BI. The method of input for these credentials will vary depending on the external client. Refer to the external client’s documentation for specific instructions on the use of these credentials.
The image indicates the location of each parameter found in the UI except for the password of the non-expiring credentials. While non-expiring credentials are provided by their JSON configuration files, you can view your expiring credentials under the Credentials tab in the UI.
The table below outlines the parameters that are typically required to connect to external clients.
When connecting to a host using non-expiring credentials, it is still necessary to use all the parameters listed in the EXPIRING CREDENTIALS section except for the password and username.
The format for entering your username and password uses colon separated values as seen in this example username:{your_username}
and password:{password_string}
.
Parameter | Description | Example |
---|---|---|
Server/Host | The name of the server/host that you are connecting to.
|
acme.platform.adobe.io |
Port | The port for the server/host you are connecting to.
|
80 |
Database | The database that you are connecting to.
|
prod:all |
Username | The username for the user who is connecting to the external client.
|
ECBB80245ECFC73E8A095EC9@AdobeOrg |
Password | The password for the user who is connecting to the external client.
|
|
Now that you understand how both expiring and non-expiring credentials work, you can use these credentials to connect to external clients. For more information detailed information about external clients, please read the connect clients to Query Service guide.