配置身份验证

您正在查看 Apigee X 文档。
查看 Apigee Edge 文档。

集成允许您保存客户端的身份验证配置文件。因此,您只需配置一次身份验证,即可跨集成重复使用同一配置。

要创建身份验证配置文件,请执行以下步骤:

  1. 要使用的身份验证配置文件字段中,选择添加新的身份验证配置
  2. 身份验证配置文件对话框中,输入以下详细信息:
    • 配置文件名称:输入配置的自定义名称。
    • 配置文件说明:输入配置的说明。
    • 身份验证类型 (Authentication type):选择身份验证类型并输入身份验证所需的信息。根据您选择的授权类型,界面会显示身份验证所需的相应字段。如需了解所有受支持的身份验证类型,请参阅 [身份验证类型部分的待定链接]。
  3. 点击保存

保存配置文件后,新创建的配置文件将显示在要使用的身份验证配置文件下拉列表中。从下拉列表中选择配置文件。

身份验证类型

您要使用的身份验证类型取决于在授权服务器中配置的身份验证。授权服务器可以是独立的服务器,也可以是 API。集成支持用于连接到授权服务器的以下身份验证类型:

  • 身份验证令牌
  • 仅限客户端证书
  • Jwt - JSON Web 令牌
  • OAuth2 授权代码
  • OAuth2 客户端凭据
  • OAuth2 资源所有者凭据
  • 服务帐号
  • 用户名和密码

下表介绍了各种身份验证类型以及相应的配置参数。

身份验证类型 说明 配置参数
身份验证令牌 基于简单令牌的身份验证 TYPE:身份验证类型 [待定:有哪些受支持的身份验证类型?是否需要说明?]

TOKEN:身份验证令牌

仅限客户端证书 基于 SSL/TLS 证书的身份验证 SSL/TLS 证书

上传 SSL/TLS 证书和相应的私钥。

Jwt 基于 JSON Web 令牌 (JWT) 的身份验证。如需详细了解 JWT,请参阅 https://tools.ietf.org/html/rfc7519 JWT HEADER:用于生成签名的算法。

注意:您只能指定 HS256 算法。

JWT PAYLOAD:一组声明。您可以使用已注册、公开和自定义的声明。

SECRET:客户端与身份验证服务器之间的共享密钥。

OAuth2 授权代码 基于 OAuth 2.0 的身份验证

在此身份验证中,您会被重定向到查看集成应用的访问权限。向应用授权后,您会被重定向回应用并获得一个临时代码。应用使用该临时代码获取用于访问受保护资源的访问令牌。

AUTHENTICATION URL:身份验证的网址。

TOKEN URL:端点网址,用于授予或刷新访问令牌。

CLIENT ID:身份验证服务器提供的客户端 ID。

CLIENT SECRET:客户端与身份验证服务器之间的共享密钥。

SCOPE:访问令牌的范围。

您可以通过范围来指定用户的访问权限。您可以指定多个范围,以空格分隔。

[介绍如何使用此类身份验证的教程的待定链接]

OAuth2 客户端凭据 基于 OAuth 2.0 的身份验证

在此身份验证中,您首先使用客户端凭据请求访问令牌,然后使用该访问令牌访问受保护的资源。

CLIENT ID:[待定]

CLIENT SECRET:客户端与身份验证服务器之间的共享密钥。

TOKEN ENDPOINT:端点网址,用于授予或刷新访问令牌。

SCOPE:访问令牌的范围。

您可以通过范围来指定用户的访问权限。您可以指定多个范围,以空格分隔。

REQUEST TYPES:将请求参数发送至身份验证服务器的机制。支持以下请求类型:

  • 编码器标头 - 对请求参数进行编码,并在请求标头中发送参数。
  • 查询参数 - 以查询参数的形式发送请求参数。
  • 请求正文 - 在请求正文中发送请求参数。

    TOKEN PARAMETERS:获取令牌所需的请求参数。

OAuth2 资源所有者凭据 基于 OAuth 2.0 的身份验证

在此身份验证中,您首先使用所有者凭据请求访问令牌,然后使用该访问令牌访问受保护的资源。

CLIENT ID:[待定]

CLIENT SECRET:客户端与身份验证服务器之间的共享密钥。

USERNAME:用于身份验证的用户名。

PASSWORD:用于身份验证的密码。

TOKEN ENDPOINT:端点网址,用于授予或刷新访问令牌。

SCOPE:访问令牌的范围。

您可以通过范围来指定用户的访问权限。您可以指定多个范围,以空格分隔。

REQUEST TYPES:将请求参数发送至身份验证服务器的机制。支持以下请求类型:

  • 编码器标头 - 对请求参数进行编码,并在请求标头中发送参数。
  • 查询参数 - 以查询参数的形式发送请求参数。
  • 请求正文 - 在请求正文中发送请求参数。

    TOKEN PARAMETERS:获取令牌所需的请求参数。

服务帐号 使用 GCP 项目中的服务帐号进行身份验证。 SERVICE ACCOUNT:GCP 项目中服务帐号的名称。

注意:在 GCP 项目中,请确保您已添加具有 Service Account Token Creator 角色的 cloud-crm-ip-api-caller@prod.google.com 主帐号。

SCOPE:用户的访问权限范围。

您可以指定多个范围,以空格分隔。

用户名和密码 基于用户名和密码的身份验证。

在此身份验证中,您只需使用用户名和密码即可向身份验证服务器进行身份验证。

USERNAME:用于身份验证的用户名。

PASSWORD:用于身份验证的密码。