Aggiornare una configurazione delle credenziali
Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
Endpoint API: platform.adobe.io/data/core/activation/authoring/credentials
Questa pagina esemplifica la richiesta API e il payload che è possibile utilizzare per aggiornare una configurazione di credenziali esistente, utilizzando l'endpoint API /authoring/credentials
.
Quando utilizzare l'endpoint API /credentials
when-to-use
Nella maggior parte dei casi, non deve utilizzare l'endpoint API /credentials
. È invece possibile configurare le informazioni di autenticazione per la destinazione tramite i parametri customerAuthenticationConfigurations
dell'endpoint /destinations
.
Utilizzare questo endpoint API per creare una configurazione di credenziali solo se è presente un sistema di autenticazione globale tra Adobe e la piattaforma di destinazione e il cliente Platform non deve fornire credenziali di autenticazione per connettersi alla destinazione. In questo caso, è necessario creare una configurazione delle credenziali utilizzando l'endpoint API /credentials
.
Quando si utilizza un sistema di autenticazione globale, è necessario impostare "authenticationRule":"PLATFORM_AUTHENTICATION"
nella configurazione consegna di destinazione, durante la creazione di una nuova configurazione di destinazione.
Tutti i nomi e i valori dei parametri supportati da Destination SDK sono con distinzione tra maiuscole e minuscole. Per evitare errori di distinzione tra maiuscole e minuscole, utilizza i nomi e i valori dei parametri esattamente come mostrato nella documentazione.
Guida introduttiva alle operazioni API per le credenziali get-started
Prima di continuare, consulta la guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente chiamate all'API, tra cui come ottenere l'autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.
Aggiornare una configurazione delle credenziali update
È possibile aggiornare una configurazione delle credenziali existing effettuando una richiesta PUT
all'endpoint /authoring/credentials
con il payload aggiornato.
Per ottenere una configurazione delle credenziali esistente e i corrispondenti {INSTANCE_ID}
, vedere l'articolo relativo al recupero di una configurazione delle credenziali.
Formato API
PUT /authoring/credentials/{INSTANCE_ID}
Le seguenti richieste aggiornano le configurazioni delle credenziali esistenti, definite dai parametri forniti nel payload.
Seleziona ciascuna scheda di seguito per visualizzare il payload corrispondente.
Base
Aggiornare una configurazione delle credenziali di base
accordion |
Richiesta |
code language-shell |
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"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto |
|
|
Parametro |
Tipo |
Descrizione |
url |
Stringa |
URL del provider di autorizzazione |
username |
Stringa |
Nome utente di accesso alla configurazione credenziali |
password |
Stringa |
Password di accesso alla configurazione delle credenziali |
|
accordion |
Risposta |
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata. |
Amazon S3
Aggiorna una configurazione delle credenziali Amazon S3
accordion |
Richiesta |
code language-shell |
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"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parametro |
Tipo |
Descrizione |
accessId |
Stringa |
ID di accesso Amazon S3 |
secretKey |
Stringa |
Chiave segreta Amazon S3 |
|
accordion |
Risposta |
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata. |
SSH
Aggiorna una configurazione delle credenziali SSH
accordion |
Richiesta |
code language-shell |
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"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parametro |
Tipo |
Descrizione |
username |
Stringa |
Nome utente di accesso alla configurazione credenziali |
sshKey |
Stringa |
Chiave SSH per SFTP con autenticazione SSH |
|
accordion |
Risposta |
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata. |
Archiviazione Azure Data Lake
Aggiorna una configurazione delle credenziali Azure Data Lake Storage
accordion |
Richiesta |
code language-shell |
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"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto |
|
|
Parametro |
Tipo |
Descrizione |
url |
Stringa |
URL del provider di autorizzazione |
tenant |
Stringa |
Tenant archiviazione Azure Data Lake |
servicePrincipalId |
Stringa |
ID Azure Service Principal per Azure Data Lake Storage |
servicePrincipalKey |
Stringa |
Azure Service Principal Key per Azure Data Lake Storage |
|
accordion |
Risposta |
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata. |
Archiviazione BLOB di Azure
Aggiorna una configurazione delle credenziali Azure Blob
accordion |
Richiesta |
code language-shell |
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"
}
}
|
table 0-row-3 1-row-3 layout-auto |
|
|
Parametro |
Tipo |
Descrizione |
connectionString |
Stringa |
Azure Blob Storage stringa di connessione |
|
accordion |
Risposta |
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata. |
Gestione degli errori API error-handling
Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Consulta Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Platform.
Passaggi successivi next-steps
Dopo aver letto questo documento, ora sai come aggiornare una configurazione di credenziali utilizzando l'endpoint API /authoring/credentials
. Leggi come utilizzare Destination SDK per configurare la destinazione per capire in che modo questo passaggio si inserisce nel processo di configurazione della destinazione.