Credentials endpoint API 操作

重要

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

このページでは、/authoring/credentials API エンドポイントを使用して実行できるすべての API 操作について説明します。

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

重要

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

Adobeと宛先の間にグローバル認証システムがあり、Platform 顧客が宛先に接続するための認証資格情報を提供する必要がない場合は、この API エンドポイントを使用し、 宛先設定 PLATFORM_AUTHENTICATION を選択します。 この場合、/credentials API エンドポイントを使用して資格情報オブジェクトを作成する必要があります。

資格情報設定 API 操作の概要

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

資格情報設定の作成

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

API 形式

POST /authoring/credentials

リクエスト

次のリクエストは、ペイロードで指定されたパラメーターで設定された、新しい資格情報設定を作成します。 以下のペイロードには、/authoring/credentials エンドポイントが受け入れるすべてのパラメーターが含まれています。 すべてのパラメーターを呼び出しに追加する必要はなく、API の要件に従ってテンプレートをカスタマイズできます。

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: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "oauth2UserAuthentication":{
      "url":"string",
      "clientId":"string",
      "clientSecret":"string",
      "username":"string",
      "password":"string",
      "header":"string"
   },
   "oauth2ClientAuthentication":{
      "url":"string",
      "clientId":"string",
      "clientSecret":"string",
      "header":"string",
      "developerToken":"string"
   },
   "oauth2AccessTokenAuthentication":{
      "accessToken":"string",
      "expiration":"string",
      "username":"string",
      "userId":"string",
      "url":"string",
      "header":"string"
   },
   "oauth2RefreshTokenAuthentication":{
      "refreshToken":"string",
      "expiration":"string",
      "clientId":"string",
      "clientSecret":"string",
      "url":"string",
      "header":"string"
   }
}
パラメーター タイプ 説明
username 文字列 資格情報ログインユーザー名
password 文字列 資格情報ログインパスワード
url 文字列 認証プロバイダーの URL
clientId 文字列 クライアント/アプリケーション資格情報のクライアント ID
clientSecret 文字列 クライアント/アプリケーション資格情報のクライアント秘密鍵
accessToken 文字列 認証プロバイダーから提供されたアクセストークン
expiration 文字列 アクセストークンの有効期間
refreshToken 文字列 認証プロバイダーから提供された更新トークン
header 文字列 認証に必要なヘッダー

応答

正常な応答は、HTTP ステータス 200 と、新しく作成された資格情報設定の詳細を返します。

資格情報設定のリスト

/authoring/credentials エンドポイントに対してGETリクエストを実行することで、IMS 組織のすべての資格情報設定のリストを取得できます。

API 形式

GET /authoring/credentials

リクエスト

次のリクエストは、IMS 組織とサンドボックス設定に基づいて、アクセス権のある資格情報設定のリストを取得します。

curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

応答

次の応答は、使用した IMS 組織 ID とサンドボックス名に基づいて、アクセス権のある資格情報設定のリストと共に HTTP ステータス 200 を返します。 1 つの instanceId は、1 つの資格情報設定のテンプレートに対応します。 応答は短く切り捨てられます。

{
   "items":[
      {
         "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
         "createdDate":"2021-06-07T06:41:48.641943Z",
         "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
         "type":"OAUTH2_USER_CREDENTIAL",
         "name":"yourdestination",
         "oauth2UserAuthentication":{
            "url":"ABCD",
            "clientId":"ABCDEFGHIJKL",
            "clientSecret":"clientsecret",
            "username":"username",
            "password":"password",
            "header":"header"
         }
      }
   ]
}
    

既存の資格情報設定の更新

既存の資格情報の設定を更新するには、/authoring/credentials エンドポイントにPUTリクエストを送信し、更新する資格情報設定のインスタンス ID を指定します。 呼び出しの本文で、更新された資格情報の設定を指定します。

API 形式

PUT /authoring/credentials/{INSTANCE_ID}
パラメーター 説明
{INSTANCE_ID} 更新する資格情報設定の ID。

リクエスト

次のリクエストは、ペイロードで指定されたパラメーターで設定された既存の資格情報設定を更新します。

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"OAUTH2_USER_CREDENTIAL",
   "name":"yourdestination",
   "oauth2UserAuthentication":{
      "url":"ABCD",
      "clientId":"ABCDEFGHIJKL",
      "clientSecret":"clientsecret",
      "username":"username",
      "password":"password",
      "header":"header"
   }
}

特定の資格情報の設定の取得

特定の資格情報設定に関する詳細な情報を取得するには、/authoring/credentials エンドポイントにGETリクエストを送信し、更新する資格情報設定のインスタンス ID を指定します。

API 形式

GET /authoring/credentials/{INSTANCE_ID}
パラメーター 説明
{INSTANCE_ID} 取得する資格情報設定の ID。

リクエスト

curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、HTTP ステータス 200 と、指定された資格情報設定に関する詳細情報を返します。

{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"OAUTH2_USER_CREDENTIAL",
   "name":"yourdestination",
   "oauth2UserAuthentication":{
      "url":"ABCD",
      "clientId":"ABCDEFGHIJKL",
      "clientSecret":"clientsecret",
      "username":"username",
      "password":"password",
      "header":"header"
   }
}

特定の資格情報設定の削除

/authoring/credentials エンドポイントにDELETEリクエストを送信し、リクエストパスで削除する資格情報設定の ID を指定することで、指定した資格情報設定を削除できます。

API 形式

DELETE /authoring/credentials/{INSTANCE_ID}
パラメーター 説明
{INSTANCE_ID} 削除する資格情報設定の id

リクエスト

curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/credentials/n55affa0-3747-4030-895d-1d1236bb3680 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

応答

正常な応答は、HTTP ステータス 200 と空の HTTP 応答を返します。

API エラー処理

宛先 SDK API エンドポイントは、一般的なExperience PlatformAPI エラーメッセージの原則に従います。 Platform トラブルシューティングガイドの API ステータスコード および リクエストヘッダーのエラー を参照してください。

次の手順

このドキュメントを読むと、資格情報エンドポイントを使用するタイミングと、 /authoring/credentials API エンドポイントまたは /authoring/destinations エンドポイントを使用して資格情報を設定する方法がわかります。 宛先 SDK を使用して宛先を設定する方法 を読んで、この手順が宛先の設定プロセスにどのように適しているかを確認してください。

このページ