Documentation Experience Platform Guide des destinations

Mise à jour d’une configuration d’informations d’identification

Dernière mise à jour : 16 juillet 2024

Rubriques :
Destinations

Créé pour :

Administration
Utilisateur ou utilisatrice

IMPORTANT

Point d’entrée de l’API : platform.adobe.io/data/core/activation/authoring/credentials

Cette page illustre la requête d’API et la payload que vous pouvez utiliser pour mettre à jour une configuration d’informations d’identification existante à l’aide du point d’entrée /authoring/credentials de l’API.

Quand utiliser le point d’entrée de l’API `/credentials`

IMPORTANT

Dans la plupart des cas, vous ne devez pas utiliser le point d’entrée de l’API /credentials. Au lieu de cela, vous pouvez configurer les informations d’authentification pour votre destination via les paramètres customerAuthenticationConfigurations du point d’entrée /destinations.

Pour en savoir plus sur les types d’authentification pris en charge, consultez la documentation Configuration de l’authentification du client.

Utilisez ce point d’entrée de l’API pour créer une configuration d’informations d’identification uniquement s’il existe un système d’authentification global entre Adobe et votre plateforme de destination et si le client Platform n’a pas besoin de fournir d’informations d’authentification pour se connecter à la destination. Dans ce cas, vous devez créer une configuration d’informations d’identification à l’aide du point d’entrée /credentials de l’API.

Quand vous utilisez un système d’authentification global, vous devez définir "authenticationRule":"PLATFORM_AUTHENTICATION" dans la configuration de diffusion de destination au moment de la création d’une configuration de destination.

IMPORTANT

Tous les noms et toutes les valeurs de paramètre pris en charge par Destination SDK sont sensibles à la casse. Pour éviter les erreurs de respect de la casse, utilisez les noms et valeurs des paramètres exactement comme indiqué dans la documentation.

Prise en main des opérations de l’API des informations d’identification

Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître avant d’effectuer des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de la destination et les en-têtes obligatoires.

Mise à jour d’une configuration d’informations d’identification

Vous pouvez mettre à jour une configuration d’informations d’identification existante en effectuant une requête PUT au point d’entrée /authoring/credentials avec la payload mise à jour.

Pour obtenir une configuration d’informations d’identification existante et son {INSTANCE_ID} correspondant, consultez l’article sur la récupération d’une configuration d’informations d’identification.

Format d’API

PUT /authoring/credentials/{INSTANCE_ID}

Paramètre

Description

{INSTANCE_ID}

Identifiant de la configuration dʼinformations dʼidentification que vous souhaitez mettre à jour. Pour obtenir une configuration d’informations d’identification existante et son {INSTANCE_ID} correspondant, consultez la section Récupération d’une configuration d’informations d’identification.

Les requêtes suivantes mettent à jour des configurations d’informations d’identification, définies par les paramètres fournis dans la payload.

Sélectionnez chaque onglet ci-dessous pour afficher la payload correspondante.

De base

Mise à jour d’une configuration d’informations d’identification de base

Requête

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"
   }
}

Paramètre

Type

Description

url

Chaîne

URL du fournisseur d’autorisations

username

Chaîne

Nom d’utilisateur pour la configuration des informations d’identification

password

Chaîne

Mot de passe pour la configuration des informations d’identification

Réponse

Une réponse réussie renvoie le statut HTTP 200 avec les détails de la configuration de vos informations d’identification mise à jour.

Amazon S3

Mise à jour d’une configuration d’informations d’identification Amazon S3

Requête

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"
   }
}

Paramètre

Type

Description

accessId

Chaîne

Identifiant d’accès Amazon S3

secretKey

Chaîne

Clé secrète Amazon S3

Réponse

Une réponse réussie renvoie le statut HTTP 200 avec les détails de la configuration de vos informations d’identification mise à jour.

SSH

Mise à jour d’une configuration d’informations d’identification SSH

Requête

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"
   }
}

Paramètre

Type

Description

username

Chaîne

Nom d’utilisateur pour la configuration des informations d’identification

sshKey

Chaîne

Clé SSH pour SFTP avec l’authentication SSH

Réponse

Une réponse réussie renvoie le statut HTTP 200 avec les détails de la configuration de vos informations d’identification mise à jour.

Azure Data Lake Storage

Mise à jour d’une configuration d’informations d’identification Azure Data Lake Storage

Requête

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"
   }
}

Paramètre

Type

Description

url

Chaîne

URL du fournisseur d’autorisations

tenant

Chaîne

Client Azure Data Lake Storage

servicePrincipalId

Chaîne

Identifiant Azure Service Principal pour Azure Data Lake Storage

servicePrincipalKey

Chaîne

Azure Service Principal Key for Azure Data Lake Storage

Réponse

Une réponse réussie renvoie le statut HTTP 200 avec les détails de la configuration de vos informations d’identification mise à jour.

Stockage Azure Blob

Mise à jour d’une configuration d’informations d’identification Azure Blob

Requête

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"
   }
}

Paramètre

Type

Description

connectionString

Chaîne

chaîne de connexion Azure Blob Storage

Réponse

Une réponse réussie renvoie le statut HTTP 200 avec les détails de la configuration de vos informations d’identification mise à jour.

Gestion des erreurs d’API

Les points d’entrée de l’API Destination SDK suivent les principes généraux des messages d’erreur de l’API Experience Platform. Consultez les sections Codes dʼétat d’API et Erreurs dʼen-tête de requête dans le guide de dépannage de Platform.

Étapes suivantes

Vous êtes arrivé au bout de ce document. À présent, vous savez comment mettre à jour une configuration d’informations d’identification à l’aide du point d’entrée /authoring/credentials de l’API. Consultez la documentation Comment utiliser Destination SDK pour configurer la destination afin de comprendre la place de cette étape dans le processus de configuration de la destination.

recommendation-more-help

Mise à jour d’une configuration d’informations d’identification

Quand utiliser le point d’entrée de l’API /credentials

Prise en main des opérations de l’API des informations d’identification

Mise à jour d’une configuration d’informations d’identification

Gestion des erreurs d’API

Étapes suivantes

Quand utiliser le point d’entrée de l’API `/credentials`