Actualizar una configuración de credenciales

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

Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para actualizar una configuración de credenciales existente mediante /authoring/credentials Extremo de API.

Cuándo usar el /credentials Extremo de API when-to-use

IMPORTANT
En la mayoría de los casos, no necesita usar el /credentials Extremo de API. En su lugar, puede configurar la información de autenticación para su destino mediante el customerAuthenticationConfigurations parámetros del /destinations punto final.
Leer Configuración de autenticación del cliente para obtener información detallada sobre los tipos de autenticación admitidos.

Utilice este extremo de API para crear una configuración de credenciales solo si hay un sistema de autenticación global entre el Adobe y la plataforma de destino, y la variable Platform el cliente no necesita proporcionar credenciales de autenticación para conectarse a su destino. En este caso, debe crear una configuración de credenciales de utilizando /credentials Extremo de API.

Al utilizar un sistema de autenticación global, debe establecer "authenticationRule":"PLATFORM_AUTHENTICATION" en el envío de destino configuración, cuando creación de una nueva configuración de destino.

IMPORTANT
Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.

Introducción a las operaciones de API de credenciales get-started

Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.

Actualizar una configuración de credenciales update

Puede actualizar un existente configuración de credenciales realizando una PUT solicitud a la /authoring/credentials punto final con la carga útil actualizada.

Para obtener una configuración de credenciales existente y sus correspondientes {INSTANCE_ID}, consulte el artículo sobre recuperar una configuración de credenciales.

Formato de API

PUT /authoring/credentials/{INSTANCE_ID}
Parámetro
Descripción
{INSTANCE_ID}
El ID de la configuración de credenciales que desea actualizar. Para obtener una configuración de credenciales existente y sus correspondientes {INSTANCE_ID}, consulte Recuperar una configuración de credenciales.

Las siguientes solicitudes actualizan las configuraciones de credenciales existentes, definidas por los parámetros proporcionados en la carga útil.

Seleccione cada pestaña a continuación para ver la carga útil correspondiente.

Básico

Actualizar una configuración de credenciales básica

accordion
Solicitud
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
Parámetro Tipo Descripción
url Cadena URL del proveedor de autorización
username Cadena Nombre de usuario de inicio de sesión de configuración
password Cadena Contraseña de inicio de sesión de configuración de credenciales
accordion
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales actualizada.
Amazon S3

Actualizar un Amazon S3 configuración de credenciales

accordion
Solicitud
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
Parámetro Tipo Descripción
accessId Cadena Amazon S3 ID de acceso
secretKey Cadena Amazon S3 clave secreta
accordion
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales actualizada.
SSH

Actualizar un SSH configuración de credenciales

accordion
Solicitud
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
Parámetro Tipo Descripción
username Cadena Nombre de usuario de inicio de sesión de configuración
sshKey Cadena SSH clave para SFTP con SSH authentication
accordion
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales actualizada.
Azure Data Lake Storage

Actualizar un Azure Data Lake Storage configuración de credenciales

accordion
Solicitud
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
Parámetro Tipo Descripción
url Cadena URL del proveedor de autorización
tenant Cadena inquilino de Azure Data Lake Storage
servicePrincipalId Cadena Azure Service Principal ID para Azure Data Lake Storage
servicePrincipalKey Cadena Azure Service Principal Key for Azure Data Lake Storage
accordion
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales actualizada.
Almacenamiento de Azure Blob

Actualizar un Azure Blob configuración de credenciales

accordion
Solicitud
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
Parámetro Tipo Descripción
connectionString Cadena Azure Blob Storage cadena de conexión
accordion
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con los detalles de la configuración de credenciales actualizada.

Administración de errores de API error-handling

Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.

Pasos siguientes next-steps

Después de leer este documento, ahora sabe cómo actualizar una configuración de credenciales con la variable /authoring/credentials Extremo de API. Leer cómo utilizar Destination SDK para configurar el destino para comprender dónde encaja este paso en el proceso de configuración del destino.

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