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 hjälp av /authoring/credentials API-slutpunkt.

När ska /credentials API-slutpunkt when-to-use

IMPORTANT
I de flesta fall inte måste du använda /credentials API-slutpunkt. I stället kan du konfigurera autentiseringsinformationen för ditt mål via customerAuthenticationConfigurations parametrarna för /destinations slutpunkt.
Läs Konfiguration av kundautentisering för detaljerad 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 Platform Kunden behöver inte ange några autentiseringsuppgifter för att ansluta till ditt mål. I det här fallet måste du skapa en autentiseringskonfiguration med /credentials API-slutpunkt.

När du använder ett globalt autentiseringssystem måste du ange "authenticationRule":"PLATFORM_AUTHENTICATION" i destinationsleverans konfiguration, när skapa en ny målkonfiguration.

IMPORTANT
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänslig. 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 granska komma igång-guide för viktig information som du behöver känna till för att kunna anropa API:t, inklusive hur du får nödvändig behörighet för målredigering och obligatoriska huvuden.

Uppdatera en konfiguration för autentiseringsuppgifter update

Du kan uppdatera en befintlig konfiguration av autentiseringsuppgifter genom att göra en PUT begäran till /authoring/credentials slutpunkt med uppdaterad nyttolast.

Så här hämtar du en befintlig autentiseringskonfiguration och dess motsvarande {INSTANCE_ID}, se artikeln om 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. Så här hämtar du en befintlig autentiseringskonfiguration och dess motsvarande {INSTANCE_ID}, se Hämta en konfiguration för autentiseringsuppgifter.

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 konfiguration av 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 '
{
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}
table 0-row-3 1-row-3 2-row-3 layout-auto
Parameter Typ Beskrivning
accessId Sträng Amazon S3 åtkomst-ID
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 konfiguration av 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 '
{
    "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 tangent 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-lagring

Uppdatera en Azure Data Lake Storage konfiguration av 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 '
{
    "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 for 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 konfiguration av 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 '
{
    "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 fel i begäranhuvudet i felsökningsguiden för plattformen.

Nästa steg next-steps

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

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