更新凭据配置

上次更新: 2023-10-31
  • 创建对象:
  • Admin
    User
重要

API端点platform.adobe.io/data/core/activation/authoring/credentials

本页举例说明了可用于更新现有凭据配置的API请求和有效负载,使用 /authoring/credentials API端点。

何时使用 /credentials API端点

重要

在大多数情况下,您 不要 需要使用 /credentials API端点。 您而是可以通过配置目标的身份验证信息 customerAuthenticationConfigurations 的参数 /destinations 端点。

读取 客户身份验证配置 以了解有关支持的身份验证类型的详细信息。

只有在Adobe和目标平台之间存在全局身份验证系统,并且 Platform 客户无需提供任何身份验证凭据即可连接到您的目标。 在这种情况下,您必须使用创建凭据配置 /credentials API端点。

在使用全局身份验证系统时,必须设置 "authenticationRule":"PLATFORM_AUTHENTICATION"目标投放 配置,时间 创建新的目标配置.

重要

Destination SDK支持的所有参数名称和值包括 区分大小写. 为避免出现区分大小写错误,请完全按照文档中的说明使用参数名称和值。

凭据API操作快速入门

在继续之前,请查看 快速入门指南 获取成功调用API所需了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。

更新凭据配置

您可以更新 现有 凭据配置,方法是 PUT 请求 /authoring/credentials 具有更新的有效负载的端点。

获取现有的凭据配置及其相应的凭据配置 {INSTANCE_ID},请参阅关于以下内容的文章: 检索凭据配置.

API格式

PUT /authoring/credentials/{INSTANCE_ID}
参数 描述
{INSTANCE_ID} 要更新的凭据配置的ID。 获取现有的凭据配置及其相应的凭据配置 {INSTANCE_ID},请参见 检索凭据配置.

以下请求更新现有凭据配置,这些配置由有效负载中提供的参数定义。

选择下面的每个选项卡以查看相应的有效负载。

更新基本凭据配置

 请求
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"
   }
}
参数 类型 描述
url 字符串 授权提供程序的URL
username 字符串 凭据配置登录用户名
password 字符串 凭据配置登录密码
 响应

成功的响应返回HTTP状态200以及已更新凭据配置的详细信息。

更新 Amazon S3 凭据配置

 请求
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"
   }
}
参数 类型 描述
accessId 字符串 Amazon S3 访问ID
secretKey 字符串 Amazon S3 密钥
 响应

成功的响应返回HTTP状态200以及已更新凭据配置的详细信息。

更新 SSH 凭据配置

 请求
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"
   }
}
参数 类型 描述
username 字符串 凭据配置登录用户名
sshKey 字符串 SSH 键用于 SFTP 替换为 SSH 身份验证
 响应

成功的响应返回HTTP状态200以及已更新凭据配置的详细信息。

更新 Azure Data Lake Storage 凭据配置

 请求
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"
   }
}
参数 类型 描述
url 字符串 授权提供程序的URL
tenant 字符串 Azure Data Lake存储租户
servicePrincipalId 字符串 Azure Service Principal ID Azure Data Lake Storage
servicePrincipalKey 字符串 Azure Service Principal Key for Azure Data Lake Storage
 响应

成功的响应返回HTTP状态200以及已更新凭据配置的详细信息。

更新 Azure Blob 凭据配置

 请求
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"
   }
}
参数 类型 描述
connectionString 字符串 Azure Blob Storage 连接字符串
 响应

成功的响应返回HTTP状态200以及已更新凭据配置的详细信息。

API错误处理

Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码请求标头错误 ,位于平台疑难解答指南中。

后续步骤

阅读本文档后,您现在知道如何使用 /authoring/credentials API端点。 读取 如何使用Destination SDK配置目标 以了解此步骤在配置目标的过程中所处的位置。

在此页面上