配置身份验证

创建连接器的一大关键是识别并正确集成其身份验证设置。 如果操作正确，一旦连接器发布到集成服务目录，用户就可以创建与该连接器的连接，就像使用目录中的任何其他连接器一样。

所有连接器都重用身份验证框架，以便可以用统一的方法处理完整的身份验证流程和连接管理。

身份验证的最终结果是，此连接器中的任何后续请求都使用每次 API 调用的身份验证流程的结果。 例如，系统会在每次 API 调用时在标头中发送持有者令牌：

连接器生成器通过简单的配置而不是大量的编码来支持以下行业标准：

• OAuth 2.0 授权代码
• 使用 PKCE 的 OAuth 2.0 授权代码
• OAuth 2.0 客户端凭据
• 基本
• API 密钥
• 个人访问令牌 (PAT)
• 自定义
• 无身份验证

由于连接器生成器与 Integration Service 框架相关联，因此定义身份验证设置现在只是一个配置问题，而不是一个复杂的过程。 这意味着该框架将处理令牌交换、刷新和任何其他此类任务。 “连接器生成器”默认使用 OAuth 2.0 授权代码，因为这是处理身份验证的最常见的供应商方法。

身份验证页面由三个组件组成：

1. 身份验证类型，它驱动身份验证框架如何反映 PKCE 的附加验证、完整令牌交换（用于 OAuth）等。 此外，它还会使用下方的属性重新配置表格，以便列出所需的属性。
   

   

   
   
2. 可以使用自定义参数和/或编辑现有参数来修改属性表。 根据下拉菜单中的身份验证类型选择，某些字段可能是必填字段并以红色指定。
   注意：更改此表中的这些属性或身份验证类型通常会使您可能已在“连接器生成器”中创建的连接失效。 在设计期间只有一个连接，需要根据最新的身份验证配置进行设置和测试。
3. 系统会根据您提供的配置自动生成“身份验证”界面。 配置期间，您在连接器生成器中看到的正是活动包用户将看到的最终结果。
   
   
   
   

身份验证表配置

无论身份验证类型如何，加载的属性表都会标识两项：

1. 用户在身份验证屏幕中看到的内容。
2. 身份验证框架如何处理身份验证。

• 表格中的每个行项目都代表一个可以由用户覆盖或不可以由用户覆盖的属性。 要在屏幕上显示给定字段，需要将其标记为 “询问用户 - 是” 。
• 每个行项目都有一个名称和一个显示名称。 名称是供应商对技术设置的预期，后者对于如何在身份验证屏幕上要求用户输入此名称非常重要。
• 每个行项目都有一个操作菜单，允许更详细地编辑属性。 您可以在此处声明需要将给定属性作为标头发送。 请参阅API 密钥部分的更多示例。

身份验证类型

在“身份验证” 选项卡中，配置连接器的身份验证类型。 支持的选项包括：

• OAuth 2.0 授权代码
• 使用 PKCE 的 OAuth 2.0 授权代码
• OAuth 2.0 客户端凭据
• 基本
• API 密钥
• 个人访问令牌 (PAT)
• 自定义
• 无身份验证

注意： 配置身份验证时，您将配置使用您的连接器的任何人需要进行身份验证的方式。 这将是您构建连接器时的身份，但也可能是最终使用您创建的连接器的其他人。

基本身份验证

1. 选择“编辑”按钮以配置每个属性。 默认情况下，“用户名”和“密码”可用。

2. 如果要添加要在身份验证期间使用的其他字段，请选择“添加参数”：

   • 显示名称 – 连接时向用户显示。
   • 类型 – 定义连接对话框中的输入字段。 从下拉列表中选择一个选项：true/false、password、test、yes/no。
   • 询问用户 – 当需要用户输入时设置为 “是” 。
   • “值” – 使用此字段设置默认值。
   • 提示文本 – 输入字段的用户指南。
   • 提供程序名称 - API 调用的技术键。
   • “作为类型发送到提供程序” – API 如何接收值。 从下拉列表中选择一个选项：配置、标头、路径、正文、查询、表单。 默认值： header 。
   
   

   

   
   
3. 选择“保存” 以保存新的身份验证参数。
4. 如果要将身份验证重置为“基本”的原始值，请使用“重置为默认值”选项。 此操作无法撤销。

OAuth 2.0 授权代码

要使用 OAuth 2.0 授权代码，您需要在要集成的应用程序中创建 OAuth 应用程序，并从中检索配置连接器所需的凭据。

配置以下字段：

• 客户端 ID
• 客户端密码
• 范围
• 授权 URL
• 令牌 URL
• 刷新令牌 URL
• 基本标头
• 令牌撤销 URL

• 刷新间隔

  注意： 应用程序的 API 文档中应提供授权、令牌和刷新令牌 URL。

使用 PKCE 的 OAuth 2.0 授权代码

带 PKCE 的 OAuth 2.0 授权代码与 OAuth 2.0 授权代码方法相同，但还包括“ OAuth2 PKCE 代码质询方法”字段。

OAuth 2.0 客户端凭据

对于 OAuth 2.0 客户端凭据，您必须配置以下字段：

• 客户端 ID
• 客户端密码
• 范围
• 令牌 URL
• 基本标头

• 刷新间隔

API 密钥

使用此选项与需要 API 密钥才能进行 API 调用的应用程序集成。

将“ API 密钥” 字段设置为所需的值。

个人访问令牌

使用此选项与需要持有者令牌才能进行 API 调用的应用程序集成。

将“个人访问令牌” 字段设置为您的持有者令牌。

自定义

您还可以使用所需的任何字段设置自定义身份验证。

无身份验证

如果您不需要用户进行身份验证即可使用连接器，请使用此选项。