定义 OAuth2 安全方案

在线编辑

OAuth2 安全方案通过 OAuth 授权标准定义了控制API操作访问权限的设置。

准备工作

必须先执行以下操作，然后才能创建 OAuth2 安全方案:
  1. 创建 OAuth 提供程序。
  2. 将 OAuth 提供程序添加到目录。 如果尚未创建任何目录，请使用“沙箱目录”。 请参阅《 OAuth 》 中的“创建和配置目录 ”步骤说明。

关于本任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息，请参阅 编辑 OpenAPI 3.0 API 定义。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

要使用 OAuth2 安全方案，必须从 API 定义中的其他位置引用该方案。 如需了解更多信息，请参阅 《在 API 上强制执行安全要求》 和 《在操作上强制执行安全要求》。

您随时可以通过点击 “源代码 ”图标 OpenAPI 源图标，直接切换到底层的 OpenAPI YAML源代码。 要返回设计表单，请点击 “表单 ”图标 表单图标。

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 如果已定义一个或多个安全方案，请展开 安全方案。
  3. 要创建一个 OAuth2 安全方案，请单击 “安全方案 ”旁边的添加 OpenAPI 2.0 API 添加图标 图标，然后选择“ oauth2 ”。 要编辑现有 OAuth2 安全方案，请单击导航窗格中的安全方案名称。
  4. 在 安全方案名称 字段中输入您选择的标识名称。
  5. 提供以下信息：
    • 安全方案名称: 您选择的标识名称。
    • OAuth 提供商 ：选择要使用的 OAuth 提供商。
    • 流: 选择下列其中一个选项:
      • implicit
      • 资源所有者 - 密码
      • 应用程序
      • 访问代码
      注意： 可供选择的流程选项取决于所选 OAuth 提供商支持的选项。

      若在创建 OAuth 提供商时选择了" 资源所有者 - JWT "作为支持的授权类型，则必须为该安全方案选择" 资源所有者 - 密码 "作为流程。

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

下一步

对 API 或操作应用该安全方案。 如需了解更多信息，请参阅 《在 API 上强制执行安全要求》 和 《在操作上强制执行安全要求》。