Skapa en konfiguration för autentiseringsuppgifter

VIKTIGT

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 skapa en autentiseringskonfiguration med /authoring/credentials API-slutpunkt.

När ska du använda /credentials API-slutpunkt

VIKTIGT

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.

VIKTIGT

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

Läs igenom 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.

Skapa en autentiseringskonfiguration

Du kan skapa en ny konfiguration för autentiseringsuppgifter genom att skapa en POST begäran till /authoring/credentials slutpunkt.

API-format

POST /authoring/credentials

Följande begäranden skapar nya autentiseringskonfigurationer, som definieras av parametrarna i nyttolasten.

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

Skapa en grundläggande konfiguration för autentiseringsuppgifter

 Begäran
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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"
   }
}
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
 svar

Ett lyckat svar returnerar HTTP-status 200 med information om konfigurationen för dina nya autentiseringsuppgifter.

Skapa en Amazon S3 konfiguration av autentiseringsuppgifter

 Begäran
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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"
   }
}
Parameter Typ Beskrivning
accessId Sträng Amazon S3 åtkomst-ID
secretKey Sträng Amazon S3 hemlig nyckel
 svar

Ett lyckat svar returnerar HTTP-status 200 med information om konfigurationen för dina nya autentiseringsuppgifter.

Skapa en SSH-autentiseringskonfiguration

 Begäran
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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"
   }
}
Parameter Typ Beskrivning
username Sträng Inloggningsanvändarnamn för konfiguration av autentiseringsuppgifter
sshKey Sträng SSH-nyckel för SFTP med SSH-autentisering
 svar

Ett lyckat svar returnerar HTTP-status 200 med information om konfigurationen för dina nya autentiseringsuppgifter.

Skapa en Azure Data Lake Storage konfiguration av autentiseringsuppgifter

 Begäran
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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"
   }
}
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
 svar

Ett lyckat svar returnerar HTTP-status 200 med information om konfigurationen för dina nya autentiseringsuppgifter.

Skapa en Azure Blob Storage konfiguration av autentiseringsuppgifter

 Begäran
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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"
   }
}
Parameter Typ Beskrivning
connectionString Sträng Azure Blob Storage anslutningssträng
 svar

Ett lyckat svar returnerar HTTP-status 200 med information om konfigurationen för dina nya autentiseringsuppgifter.

API-felhantering

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

När du har läst det här dokumentet vet du nu när du ska använda slutpunkten för autentiseringsuppgifter och hur du ställer in en konfiguration för autentiseringsuppgifter med /authoring/credentials Läs API-slutpunkt 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.

På denna sida