创建 OAuth 安全性定义

创建 OAuth 安全性定义时,需要提供一些设置,以通过 OAuth 授权标准来控制对 API 操作的访问。

开始之前

在创建 OAuth 安全性定义之前,必须完成以下操作:
  1. 创建 OAuth 提供者。
  2. 将 OAuth 提供者添加到目录。如果尚未创建任何目录,请使用“沙箱目录”。请参阅创建和配置目录中的 OAuth 指示信息步骤

关于此任务

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

过程

要创建 OAuth 安全性定义,请完成以下步骤:

  1. 在导航窗格中,单击 API UI 导航窗格中的“开发”图标 开发 这样会打开 API 和产品列示页面。
  2. 要在现有 API 中创建安全性定义,请单击要使用的 API。要创建将向其添加安全性定义的新 API,请参阅创建 API 定义
  3. 浏览至安全性定义部分。
  4. 安全性定义部分,单击添加
  5. 输入安全性定义的名称和可选描述。
  6. 对于“类型”,请选择 OAuth2
  7. OAuth 提供者菜单中选择要在此安全性定义中使用的提供者。
    注: 可供您选择的 OAuth 提供者为已连接到的管理服务器和提供者组织的沙箱目录中指定的 OAuth 提供者。

    如果使用的是 API Manager 用户界面,那么连接详细信息根据打开的 API Manager URL 以及登录时使用的用户标识来确定。如果使用的是 API Designer 用户界面,那么首次启动 API Designer 时,请在打开的登录窗口中提供管理服务器详细信息和用户标识;请参阅登录到 API Connect Designer

    如果在脱机 API Designer 中工作,那么必须输入 OAuth 提供程序的确切名称。

    有关如何指定沙箱目录中的 OAuth 提供者的详细信息,请参阅创建和配置目录

  8. 菜单中,选择提供者的授权类型。

    受支持的流类型为应用程序资源所有者密码访问代码隐式。在“令牌 URL”和“授权 URL”的条目中将自动显示适用于流类型的端点值。例如:

    设置
    Application
    令牌 URL https://example.com/samplenative/oauth2/token
    注: 仅出于提供信息目的维护授权 URL令牌 URLAPI Connect 不对它们应用任何验证或其他操作。
  9. (可选)通过单击添加来指定其他作用域。对于每个额外的作用域,请指定名称描述
  10. 单击保存以保存更改。

下一步做什么

将安全性定义应用于 API 或者一个或多个 API 操作。有关更多信息,请参阅向 API 应用安全性定义向 API 操作应用安全性定义

时间戳记图标 上次更新时间:2019-06-21