为自助源配置身份验证规范(批处理SDK)

最近更新： 2025年4月4日
  • 主题：

创建对象：

  • 开发人员

身份验证规范定义Adobe Experience Platform用户可以如何连接到您的源。

authSpec数组包含有关将源连接到Experience Platform所需的身份验证参数的信息。 任何给定的源都可以支持多种不同类型的身份验证。

身份验证规范

自助式源(批处理SDK)支持OAuth 2刷新代码和基本身份验证。 有关使用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