跳转到主要内容您可以在左侧窗格的 Configuration 选项卡中创建并配置 Vantage API 客户端。
要创建 API 客户端,请按以下步骤操作:
- 单击 Create API Client。
- 在弹出的对话框中,会显示已创建客户端的 Client ID 和 Client Secret。您可以单击其旁边的图标保存这些值。或者,单击 Save to File 按钮并指定位置,将包含 Client ID 和 Client Secret 的 TXT 文件保存到该位置。
重要! Secret 值仅在创建客户端时显示一次,请务必立即保存。
- 单击 Close。
完成上述步骤后,系统将自动跳转到该客户端的编辑页面。在此,您可以:
- 更改 Client Name field 中指定的客户端名称。
- 单击 Add Secret 创建新的 secret。默认有效期为 6 个月。
- 单击 Add Redirect URL 添加新的重定向 URL。
- 在 OAuth 2.0 Flows Settings 部分配置允许的身份验证流。请注意,您可以选择多个流:
- Allow Authorization Code Flow。允许使用此安全的身份验证方案;应用程序不会将身份验证请求转交给用户,而是直接发送到 Vantage 授权服务器。授权服务器验证用户凭据后向客户端提供授权码。Authorization Code Flow 对所有 Vantage API 客户端默认启用。如有需要:
- 选择 Require PKCE for Authorization Code Flow 选项。该选项在授权公共客户端时可增强安全性,使 Vantage 能验证请求访问令牌的应用与发起身份验证的应用是否一致。
- 选择 Allow issuing refresh tokens to refresh access tokens。该选项允许签发用于获取新访问令牌的刷新令牌。应用可使用刷新令牌请求新的访问令牌而无需与用户交互。应用必须安全存储刷新令牌,因为它们可使用户保持已登录状态。
- Allow Resource Owner Password Credentials Flow。允许用户使用其用户名和密码进行身份验证。这意味着应用程序将接触到用户密码,因而需要用户与应用之间具备高度信任。
注意: 配置了 External Identity Provider 时,此流不可用。
- Allow client credentials flow。允许应用程序使用 OAuth 2.0 Client Credentials 流进行授权,从而访问 Vantage API。分配给应用程序的角色由 Allow client credentials flow 下方的 Manage Roles 设置决定。应用程序将以指定角色登录 Vantage。
有关身份验证流的更多信息,请参阅 Authentication。
如需创建新客户端,请在 New Client 下拉列表中选择 Add Client。该列表还会显示所有现有客户端,单击任一客户端即可打开其编辑页面。此外,您还可以按客户端名称和角色进行搜索。
要删除客户端,请单击该图标,然后单击 Delete Client。
