文件Experience Platform目的地指南

更新認證設定

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • undefined
  • undefined
IMPORTANT
API端點： platform.adobe.io/data/core/activation/authoring/credentials

此頁面是您可用來使用/authoring/credentials API端點更新現有認證設定的API要求與裝載範例。

何時使用/credentials API端點 when-to-use

IMPORTANT
在大多數情況下，您​ 不 ​需要使用/credentials API端點。 您可以改為透過/destinations端點的customerAuthenticationConfigurations引數來設定您目的地的驗證資訊。
閱讀客戶驗證組態，以取得支援的驗證型別的詳細資訊。

只有在Adobe和您的目的地平台之間有全域驗證系統，且Platform客戶不需要提供任何驗證認證即可連線到您的目的地時，才使用此API端點來建立認證設定。 在此情況下，您必須使用/credentials API端點建立認證組態。

使用全域驗證系統時，在建立新的目的地組態時，您必須在目的地傳遞組態中設定"authenticationRule":"PLATFORM_AUTHENTICATION"。

IMPORTANT
Destination SDK支援的所有引數名稱和值都區分大小寫​**​**。 為避免區分大小寫錯誤，請完全依照檔案中所示使用引數名稱和值。

認證API操作快速入門 get-started

繼續之前，請檢閱快速入門手冊以取得重要資訊，您必須瞭解這些資訊才能成功呼叫API，包括如何取得必要的目的地撰寫許可權和必要的標頭。

更新認證設定 update

您可以藉由使用更新的承載對/authoring/credentials端點發出PUT要求，來更新現有認證設定。

若要取得現有的認證組態及其對應的{INSTANCE_ID}，請參閱有關擷取認證組態的文章。

API格式

PUT /authoring/credentials/{INSTANCE_ID}
參數
說明
{INSTANCE_ID}
您要更新的認證設定ID。 若要取得現有的認證組態及其對應的{INSTANCE_ID}，請參閱擷取認證組態。

以下請求會更新由承載中提供的引數定義的現有認證設定。

選取下方的每個索引標籤以檢視對應的裝載。

基本

更新基本認證組態

accordion
要求
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
參數 類型 說明
url 字串 授權提供者的URL
username 字串 認證組態登入使用者名稱
password 字串 認證組態登入密碼
accordion
回應
成功的回應會傳回HTTP狀態200以及您更新的認證設定的詳細資料。
Amazon S3

更新Amazon S3認證組態

accordion
要求
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
參數 類型 說明
accessId 字串 Amazon S3存取識別碼
secretKey 字串 Amazon S3秘密金鑰
accordion
回應
成功的回應會傳回HTTP狀態200以及您更新的認證設定的詳細資料。
SSH

更新SSH認證組態

accordion
要求
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
參數 類型 說明
username 字串 認證組態登入使用者名稱
sshKey 字串 具有SSH驗證的SFTP的SSH金鑰
accordion
回應
成功的回應會傳回HTTP狀態200以及您更新的認證設定的詳細資料。
Azure Data Lake儲存體

更新Azure Data Lake Storage認證組態

accordion
要求
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
參數 類型 說明
url 字串 授權提供者的URL
tenant 字串 Azure Data Lake Storage租使用者
servicePrincipalId 字串 Azure Data Lake Storage的Azure Service Principal ID
servicePrincipalKey 字串 Azure Data Lake Storage的Azure Service Principal Key
accordion
回應
成功的回應會傳回HTTP狀態200以及您更新的認證設定的詳細資料。
Azure Blob儲存體

更新Azure Blob認證組態

accordion
要求
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
參數 類型 說明
connectionString 字串 Azure Blob Storage連線字串
accordion
回應
成功的回應會傳回HTTP狀態200以及您更新的認證設定的詳細資料。

API錯誤處理 error-handling

Destination SDK API端點遵循一般Experience Platform API錯誤訊息原則。 請參閱Platform疑難排解指南中的API狀態碼和請求標頭錯誤。

後續步驟 next-steps

閱讀此檔案後，您現在知道如何使用/authoring/credentials API端點更新認證設定。 閱讀如何使用Destination SDK來設定您的目的地，以瞭解此步驟在設定目的地的過程中適合到什麼位置。

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