Aggiornare una configurazione delle credenziali

IMPORTANT
Endpoint API: platform.adobe.io/data/core/activation/authoring/credentials

Questa pagina illustra la richiesta API e il payload che è possibile utilizzare per aggiornare una configurazione di credenziali esistente, utilizzando /authoring/credentials Endpoint API

Quando utilizzare il /credentials Endpoint API when-to-use

IMPORTANT
Nella maggior parte dei casi, non devono utilizzare /credentials Endpoint API È invece possibile configurare le informazioni di autenticazione per la destinazione tramite customerAuthenticationConfigurations parametri di /destinations endpoint.
Letto Configurazione autenticazione cliente per informazioni dettagliate sui tipi di autenticazione supportati.

Utilizzare questo endpoint API per creare una configurazione di credenziali solo se esiste un sistema di autenticazione globale tra Adobe e la piattaforma di destinazione e Platform Il cliente non deve fornire credenziali di autenticazione per connettersi alla destinazione. In questo caso, è necessario creare una configurazione delle credenziali utilizzando /credentials Endpoint API

Quando si utilizza un sistema di autenticazione globale, è necessario impostare "authenticationRule":"PLATFORM_AUTHENTICATION" nel consegna di destinazione configurazione, quando creazione di una nuova configurazione di destinazione.

IMPORTANT
Tutti i nomi e i valori dei parametri supportati da Destination SDK sono distinzione maiuscole/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, controlla guida introduttiva per informazioni importanti che è necessario 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 esistente configurazione delle credenziali effettuando una PUT richiesta al /authoring/credentials con il payload aggiornato.

Per ottenere una configurazione delle credenziali esistente e la corrispondente {INSTANCE_ID}, consulta l’articolo su recupero di una configurazione di credenziali.

Formato API

PUT /authoring/credentials/{INSTANCE_ID}
Parametro
Descrizione
{INSTANCE_ID}
ID della configurazione delle credenziali che si desidera aggiornare. Per ottenere una configurazione delle credenziali esistente e la corrispondente {INSTANCE_ID}, vedi Recuperare una configurazione di credenziali.

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 di base delle credenziali

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

Aggiornare un Amazon S3 configurazione credenziali

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 Amazon S3 ID accesso
secretKey Stringa Amazon S3 chiave segreta
accordion
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli della configurazione delle credenziali aggiornata.
SSH

Aggiornare un SSH configurazione credenziali

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 SSH chiave per SFTP con SSH autenticazione
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

Aggiornare un Azure Data Lake Storage configurazione credenziali

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 Azure Service Principal ID 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

Aggiornare un Azure Blob configurazione credenziali

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. Fai riferimento a 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 /authoring/credentials Endpoint API Letto come utilizzare Destination SDK per configurare la destinazione per capire in che modo questo passaggio si inserisce nel processo di configurazione della destinazione.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6