Aktualisieren einer Berechtigungskonfiguration
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
API-Endpunkt: platform.adobe.io/data/core/activation/authoring/credentials
Auf dieser Seite werden die API-Anfrage und die Payload erläutert, die Sie verwenden können, um eine vorhandene Berechtigungskonfiguration mithilfe des API-Endpunkts /authoring/credentials
zu aktualisieren.
Verwendung des API-Endpunkts /credentials
when-to-use
In den meisten Fällen ist es nicht erforderlich, den API-Endpunkt /credentials
zu verwenden. Stattdessen können Sie die Authentifizierungsinformationen für Ihr Ziel über den Parameter customerAuthenticationConfigurations
des Endpunkts /destinations
konfigurieren.
Verwenden Sie diesen API-Endpunkt nur dann zum Erstellen einer Berechtigungskonfiguration, wenn ein globales Authentifizierungssystem zwischen Adobe und Ihrer Zielplattform besteht und die Platform-Kundinnen und -Kunden keine Authentifizierungsdaten bereitstellen müssen, um eine Verbindung zu Ihrem Ziel herzustellen. In diesem Fall müssen Sie mithilfe des API-Endpunkts /credentials
eine Berechtigungskonfiguration erstellen.
Bei der Verwendung eines globalen Authentifizierungssystems müssen Sie "authenticationRule":"PLATFORM_AUTHENTICATION"
in der Konfiguration des Zielversands festlegen, wenn Sie eine neue Zielkonfiguration erstellen.
Bei allen von Destination SDK unterstützten Parameternamen und Werten wird nach Groß-/Kleinschreibung unterschieden. Um Fehler bei der Groß-/Kleinschreibung zu vermeiden, verwenden Sie bitte die Parameternamen und -werte genau wie in der Dokumentation dargestellt.
Erste Schritte mit Berechtigungs-API-Vorgängen get-started
Bevor Sie fortfahren, lesen Sie Erste Schritte. Dort finden Sie die nötigen Informationen für den erfolgreichen Aufruf der API, einschließlich Details für den Abruf der erforderlichen Authoring-Berechtigung für Ziele und zu den erforderlichen Kopfzeilen.
Aktualisieren einer Berechtigungskonfiguration update
Sie können eine vorhandene Berechtigungskonfiguration durch eine PUT
-Anfrage an den Endpunkt /authoring/credentials
mit der aktualisierten Payload aktualisieren.
Wie Sie eine vorhandene Berechtigungskonfiguration und die entsprechende {INSTANCE_ID}
abrufen, erfahren Sie im Artikel zum Abrufen einer Berechtigungskonfiguration.
API-Format
PUT /authoring/credentials/{INSTANCE_ID}
{INSTANCE_ID}
Die Kennung der Berechtigungskonfiguration, die Sie aktualisieren möchten. Wie Sie eine vorhandene Berechtigungskonfiguration und die entsprechende
{INSTANCE_ID}
abrufen, erfahren Sie unter
Abrufen einer Berechtigungskonfiguration.
Mit den folgenden Anfragen werden bestehende Berechtigungskonfigurationen aktualisiert, die durch die in der Payload angegebenen Parameter definiert werden.
Wählen Sie die einzelnen Registerkarten unten aus, um die entsprechende Payload anzuzeigen.
Allgemein
Aktualisieren einer allgemeinen Berechtigungskonfiguration
accordion |
Anfrage |
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 |
Beschreibung |
url |
Zeichenfolge |
URL des Autorisierungsanbieters |
username |
Zeichenfolge |
Benutzername für die Anmeldung zur Zugriffsdaten-Konfiguration |
password |
Zeichenfolge |
Passwort für die Anmeldung zur Zugangsdaten-Konfiguration |
|
accordion |
Antwort |
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details Ihrer aktualisierten Berechtigungskonfiguration zurückgegeben. |
Amazon S3
Aktualisieren einer Amazon S3-Berechtigungskonfiguration
accordion |
Anfrage |
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 |
Beschreibung |
accessId |
Zeichenfolge |
Amazon S3 Zugriffs-ID |
secretKey |
Zeichenfolge |
Geheimer Amazon S3-Schlüssel |
|
accordion |
Antwort |
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details Ihrer aktualisierten Berechtigungskonfiguration zurückgegeben. |
SSH
Aktualisieren einer SSH-Berechtigungskonfiguration
accordion |
Anfrage |
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 |
Beschreibung |
username |
Zeichenfolge |
Benutzername für die Anmeldung zur Zugriffsdaten-Konfiguration |
sshKey |
Zeichenfolge |
SSH-Schlüssel für SFTP mit SSH-Authentifizierung |
|
accordion |
Antwort |
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details Ihrer aktualisierten Berechtigungskonfiguration zurückgegeben. |
Azure Data Lake Storage
Aktualisieren einer Azure Data Lake Storage-Berechtigungskonfiguration
accordion |
Anfrage |
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 |
Beschreibung |
url |
Zeichenfolge |
URL des Autorisierungsanbieters |
tenant |
Zeichenfolge |
Azure Data Lake Storage-Mandant |
servicePrincipalId |
Zeichenfolge |
Azure Service Principal-ID für Azure Data Lake Storage |
servicePrincipalKey |
Zeichenfolge |
Azure Service Principal Key for Azure Data Lake Storage |
|
accordion |
Antwort |
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details Ihrer aktualisierten Berechtigungskonfiguration zurückgegeben. |
Azure-Blobspeicher
Aktualisieren einer Azure Blob-Berechtigungskonfiguration
accordion |
Anfrage |
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 |
Beschreibung |
connectionString |
Zeichenfolge |
Azure Blob Storage-Verbindungszeichenfolge |
|
accordion |
Antwort |
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details Ihrer aktualisierten Berechtigungskonfiguration zurückgegeben. |
Umgang mit API-Fehlern error-handling
Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-Status-Codes und Fehler im Anfrage-Header in der Anleitung zur Fehlerbehebung für Platform.
Nächste Schritte next-steps
Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie eine Berechtigungskonfiguration mithilfe des API-Endpunkts /authoring/credentials
aktualisieren können. Lesen Sie Verwenden des Destination SDK zum Konfigurieren Ihres Ziels, um zu verstehen, wo dieser Schritt in den Prozess der Konfiguration Ihres Ziels passt.