資格情報エンドポイント API 操作

重要

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

このページでは、 /authoring/credentials API エンドポイント。

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

重要

ほとんどの場合、 しない 使用する必要がある /credentials API エンドポイント。 代わりに、 customerAuthenticationConfigurations のパラメーター /destinations endpoint. 読み取り 認証設定 を参照してください。

この API エンドポイントを使用し、「 」を選択します。 PLATFORM_AUTHENTICATION宛先設定 Adobeと宛先の間にグローバル認証システムがあり、 Platform のお客様は、宛先に接続するための認証資格情報を提供する必要はありません。 この場合、 /credentials API エンドポイント。

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

続行する前に、 入門ガイド を参照してください。

資格情報設定の作成

新しい資格情報の設定を作成するには、 /authoring/credentials endpoint.

API 形式

POST /authoring/credentials

リクエスト

次のリクエストは、ペイロードで指定されたパラメーターで設定された新しい資格情報設定を作成します。 以下のペイロードには、 /authoring/credentials endpoint. 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 と、新しく作成された資格情報設定の詳細を返します。

資格情報設定のリスト

IMS 組織のすべての資格情報設定のリストを取得するには、にGETリクエストをおこないます /authoring/credentials endpoint.

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 エンドポイントを作成し、更新する資格情報設定のインスタンス 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 エンドポイントを作成し、更新する資格情報設定のインスタンス 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 エンドポイントを作成し、リクエストパスで削除する資格情報設定の 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 エラー処理

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

次の手順

このドキュメントを読むと、資格情報エンドポイントを使用するタイミングと、 /authoring/credentials API エンドポイントまたは /authoring/destinations endpoint. 読み取り 宛先の設定にDestination SDKを使用する方法 を参照して、この手順が宛先を設定するプロセスに適した場所を把握します。

このページ