Uppdatera en konfiguration för autentiseringsuppgifter

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

Den här sidan innehåller exempel på API-begäran och nyttolast som du kan använda för att uppdatera en befintlig autentiseringskonfiguration med API-slutpunkten /authoring/credentials.

När API-slutpunkten /credentials ska användas when-to-use

IMPORTANT
I de flesta fall behöver du inte använda API-slutpunkten /credentials. I stället kan du konfigurera autentiseringsinformationen för målet via customerAuthenticationConfigurations-parametrarna för slutpunkten /destinations.
Läs Konfiguration för kundautentisering om du vill ha mer information om vilka autentiseringstyper som stöds.

Använd den här API-slutpunkten om du bara vill skapa en autentiseringskonfiguration om det finns ett globalt autentiseringssystem mellan Adobe och målplattformen, och Experience Platform-kunden inte behöver ange några autentiseringsuppgifter för att ansluta till målet. I det här fallet måste du skapa en autentiseringskonfiguration med API-slutpunkten /credentials.

När du använder ett globalt autentiseringssystem måste du ange "authenticationRule":"PLATFORM_AUTHENTICATION" i konfigurationen för målleverans när du skapar en ny målkonfiguration. Sedan måste du skapa en autentiseringskonfiguration och skicka ID:t för autentiseringsuppgiftsobjektet i parametern authenticationId i konfigurationen för målleverans.

IMPORTANT
Alla parameternamn och värden som stöds av Destination SDK är skiftlägeskänsliga. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Komma igång med API-åtgärder för autentiseringsuppgifter get-started

Innan du fortsätter bör du läsa igenom kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive hur du får nödvändig behörighet för målredigering och nödvändiga rubriker.

Uppdatera en konfiguration för autentiseringsuppgifter update

Du kan uppdatera en befintlig-autentiseringskonfiguration genom att göra en PUT-begäran till /authoring/credentials-slutpunkten med den uppdaterade nyttolasten.

Om du vill hämta en befintlig autentiseringskonfiguration och dess motsvarande {INSTANCE_ID} läser du artikeln om att hämta en autentiseringskonfiguration.

API-format

PUT /authoring/credentials/{INSTANCE_ID}
Parameter
Beskrivning
{INSTANCE_ID}
ID:t för den autentiseringskonfiguration som du vill uppdatera. Om du vill hämta en befintlig autentiseringskonfiguration och dess motsvarande {INSTANCE_ID} går du till Hämta en autentiseringskonfiguration.

Följande begäranden uppdaterar befintliga autentiseringskonfigurationer, som definieras av parametrarna i nyttolasten.

Välj varje flik nedan för att visa motsvarande nyttolast.

Grundläggande

Uppdatera en grundläggande konfiguration för autentiseringsuppgifter

accordion
Begäran
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
Parameter Typ Beskrivning
url Sträng URL för auktoriseringsleverantör
username Sträng Inloggningsanvändarnamn för konfiguration av autentiseringsuppgifter
password Sträng Inloggningslösenord för konfiguration av autentiseringsuppgifter
accordion
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade konfigurationen för autentiseringsuppgifter.
Amazon S3

Uppdatera en Amazon S3 autentiseringskonfiguration

accordion
Begäran
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
Parameter Typ Beskrivning
accessId Sträng Åtkomst-ID för Amazon S3
secretKey Sträng Amazon S3 hemlig nyckel
accordion
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade konfigurationen för autentiseringsuppgifter.
SSH

Uppdatera en SSH autentiseringskonfiguration

accordion
Begäran
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
Parameter Typ Beskrivning
username Sträng Inloggningsanvändarnamn för konfiguration av autentiseringsuppgifter
sshKey Sträng SSH-nyckel för SFTP med SSH-autentisering
accordion
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade konfigurationen för autentiseringsuppgifter.
Azure Data Lake Storage

Uppdatera en Azure Data Lake Storage autentiseringskonfiguration

accordion
Begäran
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
Parameter Typ Beskrivning
url Sträng URL för auktoriseringsleverantör
tenant Sträng Klient för Azure Data Lake Storage
servicePrincipalId Sträng Azure Service Principal-ID för Azure Data Lake Storage
servicePrincipalKey Sträng Azure Service Principal Key för Azure Data Lake Storage
accordion
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade konfigurationen för autentiseringsuppgifter.
Azure Blob Storage

Uppdatera en Azure Blob autentiseringskonfiguration

accordion
Begäran
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
Parameter Typ Beskrivning
connectionString Sträng Azure Blob Storage anslutningssträng
accordion
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade konfigurationen för autentiseringsuppgifter.

API-felhantering error-handling

Destination SDK API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och begäranrubrikfel i felsökningsguiden för Experience Platform.

Nästa steg next-steps

När du har läst det här dokumentet vet du nu hur du uppdaterar en autentiseringskonfiguration med API-slutpunkten /authoring/credentials. Läs hur du använder Destination SDK för att konfigurera ditt mål och få en förståelse för var det här steget passar in i processen att konfigurera ditt mål.

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