Een referentieconfiguratie bijwerken

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

Deze pagina illustreert de API-aanvraag en lading die u kunt gebruiken om een bestaande referentieconfiguratie bij te werken met behulp van het API-eindpunt /authoring/credentials .

Wanneer gebruikt u het API-eindpunt /credentials when-to-use

IMPORTANT
In de meeste gevallen, te hoeven u niet om het /credentials API eindpunt te gebruiken. In plaats daarvan kunt u de verificatiegegevens voor uw doel configureren via de customerAuthenticationConfigurations -parameters van het /destinations -eindpunt.
Lees ​ de authentificatieconfiguratie van de Klant ​ voor gedetailleerde informatie over de gesteunde authentificatietypen.

Gebruik dit API-eindpunt om alleen een referentie-configuratie te maken als er een algemeen verificatiesysteem is tussen Adobe en uw doelplatform. De Experience Platform -klant hoeft geen verificatiegegevens op te geven om verbinding te maken met uw bestemming. In dit geval moet u een referentieconfiguratie maken met het API-eindpunt van /credentials .

Wanneer het gebruiken van een globaal authentificatiesysteem, moet u "authenticationRule":"PLATFORM_AUTHENTICATION" in de ​ 2} configuratie van de bestemmingslevering plaatsen, wanneer ​ creërend een nieuwe bestemmingsconfiguratie . ​ Dan, moet u de configuratie van de a ​ geloofsbrieven ​ tot stand brengen en identiteitskaart van de referentie objecten in de authenticationId parameter in de ​ configuratie van de bestemmingslevering ​ overgaan.

IMPORTANT
Alle parameternamen en waarden die door Destination SDK worden gesteund zijn gevoelig geval. Om fouten in hoofdlettergevoeligheid te voorkomen, gebruikt u de namen en waarden van parameters exact zoals in de documentatie wordt getoond.

Aan de slag met API-bewerkingen voor gebruikersgegevens get-started

Alvorens verder te gaan, te herzien gelieve ​ begonnen gids ​ voor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings authoring en vereiste kopballen te verkrijgen.

Een referentieconfiguratie bijwerken update

U kunt een ​ bestaande ​ credentiële configuratie bijwerken door een PUT verzoek aan het /authoring/credentials eindpunt met de bijgewerkte nuttige lading te doen.

Om een bestaande credentiële configuratie en zijn overeenkomstige {INSTANCE_ID} te verkrijgen, zie het artikel over ​ het terugwinnen van een credentiële configuratie ​.

API formaat

PUT /authoring/credentials/{INSTANCE_ID}
Parameter
Beschrijving
{INSTANCE_ID}
De id van de referentieconfiguratie die u wilt bijwerken. Om een bestaande credentiële configuratie en zijn overeenkomstige {INSTANCE_ID} te verkrijgen, zie ​ een credentiële configuratie ​ terugwinnen.

De volgende verzoeken werken bestaande credentiële configuraties bij, die door de parameters worden bepaald die in de lading worden verstrekt.

Selecteer hieronder elk tabblad om de bijbehorende lading weer te geven.

Basis

werk een basiscredentiële configuratie bij

accordion
Verzoek
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 Type Beschrijving
url String URL van leverancier van machtigingen
username String Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens
password String Aanmeldingswachtwoord voor configuratie van referenties
accordion
Antwoord
Een succesvolle reactie keert status 200 van HTTP met de details van uw bijgewerkte credentieconfiguratie terug.
Amazon S3

werk een Amazon S3 credentiële configuratie bij

accordion
Verzoek
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 Type Beschrijving
accessId String Amazon S3 toegangs-id
secretKey String Amazon S3 geheime sleutel
accordion
Antwoord
Een succesvolle reactie keert status 200 van HTTP met de details van uw bijgewerkte credentieconfiguratie terug.
SSH

werk een SSH credentiële configuratie bij

accordion
Verzoek
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 Type Beschrijving
username String Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens
sshKey String SSH -sleutel voor SFTP met SSH -verificatie
accordion
Antwoord
Een succesvolle reactie keert status 200 van HTTP met de details van uw bijgewerkte credentieconfiguratie terug.
Azure de Opslag van het meer van Gegevens

werk een Azure Data Lake Storage credentiële configuratie bij

accordion
Verzoek
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 Type Beschrijving
url String URL van leverancier van machtigingen
tenant String Azure Data Lake Storage-huurder
servicePrincipalId String Azure Service Principal ID voor Azure Data Lake Storage
servicePrincipalKey String Azure Service Principal Key for Azure Data Lake Storage
accordion
Antwoord
Een succesvolle reactie keert status 200 van HTTP met de details van uw bijgewerkte credentieconfiguratie terug.
Azure Blob Storage

werk een Azure Blob credentiële configuratie bij

accordion
Verzoek
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 Type Beschrijving
connectionString String Azure Blob Storage verbindingstekenreeks
accordion
Antwoord
Een succesvolle reactie keert status 200 van HTTP met de details van uw bijgewerkte credentieconfiguratie terug.

API-foutafhandeling error-handling

Destination SDK API-eindpunten volgen de algemene beginselen van Experience Platform API-foutberichten. Verwijs naar ​ API statuscodes ​ en ​ de fouten van de verzoekkopbal ​ in de het oplossen van problemengids van Experience Platform.

Volgende stappen next-steps

Nadat u dit document hebt gelezen, weet u nu hoe u een referentieconfiguratie kunt bijwerken met behulp van het API-eindpunt van /authoring/credentials . Lees ​ hoe te om Destination SDK te gebruiken om uw bestemming ​ te vormen om te begrijpen waar deze stap in het proces past om uw bestemming te vormen.

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