ドキュメントExperience Platformソースコネクタガイド

セルフサービスソースの認証仕様の設定（Batch SDK）

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者

認証仕様は、Adobe Experience Platform ユーザーがソースに接続する方法を定義します。

authSpec 配列には、ソースを Platform に接続するために必要な認証パラメーターに関する情報が含まれています。 任意の特定のソースは、複数の異なるタイプの認証をサポートできます。

認証仕様

セルフサービスソース（Batch SDK）は、OAuth 2 リフレッシュコードと基本認証をサポートします。 OAuth 2 更新コードと基本認証の使用に関するガイダンスについては、以下の表を参照してください

OAuth 2 更新コード

OAuth 2 のリフレッシュコードは、一時的なアクセストークンとリフレッシュトークンを生成することで、アプリケーションへの安全なアクセスを可能にします。 アクセストークンを使用すると、他の資格情報を提供しなくてもリソースに安全にアクセスできます。また、更新トークンを使用すると、アクセストークンの有効期限が切れた後に、新しいアクセストークンを生成できます。

{
  "name": "OAuth2 Refresh Code",
  "type": "OAuth2RefreshCode",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Define auth params required for connecting to generic rest using oauth2 authorization code.",
    "properties": {
      "authorizationTestUrl": {
        "description": "Authorization test url to validate accessToken.",
        "type": "string"
      },
      "clientId": {
        "description": "Client id of user account.",
        "type": "string"
      },
      "clientSecret": {
        "description": "Client secret of user account.",
        "type": "string",
        "format": "password"
      },
      "accessToken": {
        "description": "Access Token",
        "type": "string",
        "format": "password"
      },
      "refreshToken": {
        "description": "Refresh Token",
        "type": "string",
        "format": "password"
      },
      "expirationDate": {
        "description": "Date of token expiry.",
        "type": "string",
        "format": "date",
        "uiAttributes": {
          "hidden": true
        }
      },
      "accessTokenUrl": {
        "description": "Access token url to fetch access token.",
        "type": "string"
      },
      "requestParameterOverride": {
        "type": "object",
        "description": "Specify parameter to override.",
        "properties": {
          "accessTokenField": {
            "description": "Access token field name to override.",
            "type": "string"
          },
          "refreshTokenField": {
            "description": "Refresh token field name to override.",
            "type": "string"
          },
          "expireInField": {
            "description": "ExpireIn field name to override.",
            "type": "string"
          },
          "authenticationMethod": {
            "description": "Authentication method override.",
            "type": "string",
            "enum": [
              "GET",
              "POST"
            ]
          },
          "clientId": {
            "description": "ClientId field name override.",
            "type": "string"
          },
          "clientSecret": {
            "description": "ClientSecret field name override.",
            "type": "string"
          }
        }
      }
    },
    "required": [
      "accessToken"
    ]
  }
}
プロパティ
説明
例
authSpec.name
サポートされている認証タイプの名前を表示します。
oAuth2-refresh-code
authSpec.type
ソースでサポートされている認証のタイプを定義します。
oAuth2-refresh-code
authSpec.spec
認証のスキーマ、データタイプおよびプロパティに関する情報が含まれます。
authSpec.spec.$schema
認証に使用するスキーマを定義します。
http://json-schema.org/draft-07/schema#
authSpec.spec.type
スキーマのデータタイプを定義します。
object
authSpec.spec.properties
認証に使用される資格情報に関する情報が含まれます。
authSpec.spec.properties.description
認証情報の簡単な説明を表示します。
authSpec.spec.properties.type
認証情報のデータタイプを定義します。
string
authSpec.spec.properties.clientId
アプリケーションに関連付けられたクライアント ID。 クライアント ID は、アクセストークンを取得するためにクライアントの秘密鍵と組み合わせて使用されます。
authSpec.spec.properties.clientSecret
アプリケーションに関連付けられたクライアント秘密鍵。 クライアントシークレットは、アクセストークンを取得するためにクライアント ID と組み合わせて使用されます。
authSpec.spec.properties.accessToken
アクセストークンは、アプリケーションへの安全なアクセスを許可します。
authSpec.spec.properties.refreshToken
アクセストークンの有効期限が切れると、更新トークンを使用して新しいアクセストークンが生成されます。
authSpec.spec.properties.expirationDate
アクセストークンの有効期限を定義します。
authSpec.spec.properties.refreshTokenUrl
更新トークンを取得するために使用される URL。
authSpec.spec.properties.accessTokenUrl
更新トークンを取得するために使用される URL。
authSpec.spec.properties.requestParameterOverride
認証時に上書きする資格情報パラメーターを指定できます。
authSpec.spec.required
認証に必要な資格情報を表示します。
accessToken

基本認証

基本認証は、アカウントのユーザー名とパスワードを組み合わせて使用し、アプリケーションにアクセスできる認証タイプです。

{
  "name": "Basic Authentication",
  "type": "BasicAuthentication",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "defines auth params required for connecting to rest service.",
    "properties": {
      "username": {
        "description": "Username to connect rest endpoint.",
        "type": "string"
      },
      "password": {
        "description": "Password to connect rest endpoint.",
        "type": "string",
        "format": "password"
      }
    },
    "required": [
      "username",
      "password"
    ]
  }
}
プロパティ
説明
例
authSpec.name
サポートされている認証タイプの名前を表示します。
Basic Authentication
authSpec.type
ソースでサポートされている認証のタイプを定義します。
BasicAuthentication
authSpec.spec
認証のスキーマ、データタイプおよびプロパティに関する情報が含まれます。
authSpec.spec.$schema
認証に使用するスキーマを定義します。
http://json-schema.org/draft-07/schema#
authSpec.spec.type
スキーマのデータタイプを定義します。
object
authSpec.spec.description
認証タイプに固有の詳細情報を表示します。
authSpec.spec.properties
認証に使用される資格情報に関する情報が含まれます。
authSpec.spec.properties.username
アプリケーションに関連付けられたアカウントのユーザー名。
authSpec.spec.properties.password
アプリケーションに関連付けられたアカウントのパスワード。
authSpec.spec.required
Platform に入力する必須の値として必要なフィールドを指定します。
username

認証仕様の例

MailChimp Members ソースを使用した完全な認証仕様の例を次に示します。

  "authSpec": [
    {
      "name": "OAuth2 Refresh Code",
      "type": "OAuth2RefreshCode",
      "spec": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "description": "Define auth params required for connecting to generic rest using oauth2 authorization code.",
        "properties": {
          "authorizationTestUrl": {
            "description": "Authorization test url to validate accessToken.",
            "type": "string"
          },
          "accessToken": {
            "description": "Access Token of mailChimp endpoint.",
            "type": "string",
            "format": "password"
          }
        },
        "required": [
          "accessToken"
        ]
      }
    },
    {
      "name": "Basic Authentication",
      "type": "BasicAuthentication",
      "spec": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "description": "defines auth params required for connecting to rest service.",
        "properties": {
          "username": {
            "description": "Username to connect mailChimp endpoint.",
            "type": "string"
          },
          "password": {
            "description": "Password to connect mailChimp endpoint.",
            "type": "string",
            "format": "password"
          }
        },
        "required": [
          "username",
          "password"
        ]
      }
    }
  ],

次の手順

認証仕様を入力したので、次は Platform に統合するソースのソース仕様を設定することができます。 詳しくは、 ソース仕様の設定に関するドキュメントを参照してください。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089