定义 OAuth2 安全方案组件

OAuth2 安全方案组件定义了一些设置，可用于通过 OAuth 授权标准来控制对 API 操作的访问。

1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
2. 展开 组件 ，如果已定义一个或多个安全方案组件，请展开 安全方案。
3. 要创建 OAuth2 安全方案组件，请单击 安全方案旁边的 "添加" 图标 。 要编辑现有 OAuth2 安全方案组件，请单击导航窗格中的组件名称。
4. 如果要创建新的 OAuth2 安全方案组件，那么可以从头开始创建，也可以引用其他 OAuth2 安全方案组件。
   要从头开始创建 OAuth2 安全方案组件，请在定义选项卡上提供以下信息：

   • 安全方案名称：通过此键即可在 API 定义中的其他位置引用该 OAuth2 安全方案组件；引用格式如下：

     #/components/securitySchemes/Security_Scheme_Name

   • 安全性定义类型: 选择 oauth2。
   • 流程： 从以下选项中选择一个或多个：
     • implicit
     • 资源所有者 - 密码
     • 应用程序
     • 访问代码
     注: 可供选择的流选项取决于所选 OAuth 提供者支持的选项。

     如果在创建 OAuth 提供者时选择了 资源所有者-JWT 作为受支持的授权类型，那么必须选择 资源所有者-密码 作为此安全方案的 流 。

   • OAuth 提供程序：要使用的 OAuth 提供程序的名称。 这是创建 OAuth 提供程序时自动生成的 name 字段的值。
   • 描述：OAuth2 安全方案的可选描述。 您可以将 CommonMark 语法 用于富文本格式表示。

   要引用另一 OAuth2 安全方案组件，请在引用选项卡上提供以下信息：

   • 安全方案名称：通过此键即可在 API 定义中的其他位置引用该 OAuth2 安全方案组件；引用格式如下：

     #/components/securitySchemes/Security_Scheme_Name

   • 引用来源：选择对另一 OAuth2 安全方案组件的引用。
5. 如果要编辑现有 OAuth2 安全方案组件，请提供以下信息：
   • URL 端点（适用端点取决于流类型）：
     • 授权 URL
     • 刷新 URL
     • 令牌 URL
     注意： 此处提供的 URL 端点值仅用于提供信息， API Connect 不对这些值进行验证或采取其他操作。 所应用的 OAuth 安全性取决于指定的 OAuth 提供程序。
   • 作用域:
     • 要添加新作用域，请单击 添加。 要编辑现有作用域，请单击所需作用域旁边的选项图标 ，然后单击 编辑。
     • 提供以下信息：
       • 作用域：作用域标识。
       • 描述：作用域的可选描述。 您可以将 CommonMark 语法 用于富文本格式表示。
6. 如果要创建新的 OAuth2 安全方案组件，请单击 创建。
   这会显示安全方案组件详细信息以供进一步编辑。
7. 完成后单击 保存 。