資格情報設定の作成

最終更新日: 2023-10-31
  • トピック:
  • Destinations
    このトピックの詳細を表示
  • 作成対象:
  • Admin
    User
重要

API エンドポイントplatform.adobe.io/data/core/activation/authoring/credentials

このページでは、/authoring/credentials API エンドポイントを使用して、資格情報設定を作成するために使用できる API リクエストおよびペイロードの例を示します。

/credentials API エンドポイントを使用するタイミング

重要

ほとんどの場合、/credentials API エンドポイントを使用する必要は​ありません。代わりに、/destinations エンドポイントの customerAuthenticationConfigurations パラメーターを介して宛先の認証情報を設定できます。

サポートされる認証タイプについて詳しくは、顧客認証設定を参照してください。

アドビと宛先プラットフォームとの間にグローバル認証システムがあり、Platform の顧客が宛先への接続に認証資格情報を提供する必要がない場合にのみ、この API エンドポイントを使用して資格情報設定を作成します。この場合、/credentials API エンドポイントを使用して、資格情報設定を作成する必要があります。

グローバル認証システムを使用する場合、新しい宛先設定を作成する際に、宛先配信設定で "authenticationRule":"PLATFORM_AUTHENTICATION" を設定する必要があります。

重要

Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別​されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。

資格情報 API 操作の概要

続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。

資格情報設定の作成

/authoring/credentials エンドポイントに POST リクエストを行うことで、新しい資格情報設定を作成できます。

API 形式

POST /authoring/credentials

以下のリクエストは、ペイロードで提供されるパラメーターの定義に基づいて、新しい資格情報設定を作成します。

以下の各タブを選択して、対応するペイロードを表示します。

基本資格情報設定の作成

 リクエスト
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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 POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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 POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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 POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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 Storage のテナント
servicePrincipalId 文字列 Azure Data Lake Storage の Azure サービスプリンシパル ID
servicePrincipalKey 文字列 Azure Data Lake Storage の Azure サービスプリンシパルキー
 応答

応答が成功すると、HTTP ステータス 200 が、新しく作成された資格情報設定の詳細と共に返されます。

Azure Blob Storage 資格情報設定の作成

 リクエスト
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -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 SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

このドキュメントでは、資格情報エンドポイントを使用するタイミングと、/authoring/credentials API エンドポイントを使用した資格情報設定の設定方法を確認しました。この手順が宛先設定プロセスのどこに当てはまるかを把握するには、Destination SDK を使用した宛先の設定方法を参照してください。

このページ