Atualizar uma configuração de credencial

IMPORTANT
Ponto de acesso da API: platform.adobe.io/data/core/activation/authoring/credentials

Esta página exemplifica a solicitação de API e a carga que você pode usar para atualizar uma configuração de credencial existente, usando o /authoring/credentials Endpoint da API.

Quando usar a variável /credentials Endpoint da API when-to-use

IMPORTANT
Na maioria dos casos, você não necessidade de usar o /credentials Endpoint da API. Em vez disso, você poderá configurar as informações de autenticação para seu destino por meio da customerAuthenticationConfigurations parâmetros do /destinations terminal.
Ler Configuração de autenticação do cliente para obter informações detalhadas sobre os tipos de autenticação compatíveis.

Use esse endpoint de API para criar uma configuração de credencial somente se houver um sistema de autenticação global entre o Adobe e sua plataforma de destino e o Platform O cliente não precisa fornecer credenciais de autenticação para se conectar ao seu destino. Nesse caso, você deve criar uma configuração de credencial usando o /credentials Endpoint da API.

Ao usar um sistema de autenticação global, você deve definir "authenticationRule":"PLATFORM_AUTHENTICATION" no entrega de destino configuração, quando criação de uma nova configuração de destino.

IMPORTANT
Todos os nomes e valores de parâmetros compatíveis com o Destination SDK são diferencia maiúsculas de minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.

Introdução às operações de API de credenciais get-started

Antes de continuar, reveja o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo como obter a permissão de criação de destino e os cabeçalhos necessários.

Atualizar uma configuração de credencial update

Você pode atualizar um existente configuração de credencial fazendo um PUT solicitação à /authoring/credentials terminal com a carga atualizada.

Para obter uma configuração de credencial existente e sua configuração correspondente {INSTANCE_ID}, consulte o artigo sobre recuperação de uma configuração de credencial.

Formato da API

PUT /authoring/credentials/{INSTANCE_ID}
Parâmetro
Descrição
{INSTANCE_ID}
A ID da configuração de credencial que você deseja atualizar. Para obter uma configuração de credencial existente e sua configuração correspondente {INSTANCE_ID}, consulte Recuperar uma configuração de credencial.

As solicitações a seguir atualizam as configurações de credencial existentes, definidas pelos parâmetros fornecidos na carga.

Selecione cada guia abaixo para visualizar o conteúdo correspondente.

Básico

Atualizar uma configuração básica de credencial

accordion
Solicitação
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 Descrição
url String URL do provedor de autorização
username String Nome de usuário para logon na configuração de credenciais
password String Senha de logon da configuração de credenciais
accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial atualizada.
Amazon S3

Atualizar um Amazon S3 configuração de credencial

accordion
Solicitação
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 Descrição
accessId String Amazon S3 ID de acesso
secretKey String Amazon S3 chave secreta
accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial atualizada.
SSH

Atualizar um SSH configuração de credencial

accordion
Solicitação
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 Descrição
username String Nome de usuário para logon na configuração de credenciais
sshKey String SSH chave para SFTP com SSH autenticação
accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial atualizada.
Armazenamento Azure Data Lake

Atualizar um Azure Data Lake Storage configuração de credencial

accordion
Solicitação
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 Descrição
url String URL do provedor de autorização
tenant String Locatário do Armazenamento Azure Data Lake
servicePrincipalId String Azure Service Principal ID para Azure Data Lake Storage
servicePrincipalKey String Azure Service Principal Key for Azure Data Lake Storage
accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial atualizada.
Armazenamento Azure Blob

Atualizar um Azure Blob configuração de credencial

accordion
Solicitação
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 Descrição
connectionString String Azure Blob Storage cadeia de conexão
accordion
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração de credencial atualizada.

Manipulação de erros de API error-handling

Os endpoints da API Destination SDK seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte Códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform.

Próximas etapas next-steps

Depois de ler este documento, agora você sabe como atualizar uma configuração de credencial usando o /authoring/credentials Endpoint da API. Ler como usar o Destination SDK para configurar seu destino para entender onde essa etapa se encaixa no processo de configuração do destino.

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