跳转到主要内容
在 Vantage 中,您可以创建、配置和删除 Vantage 公共 API 客户端。

在租户中创建首个 Public API 客户端

要创建 Public API 客户端,请按照以下步骤操作:
  1. 在 Vantage 中,单击 Configuration
  2. Tenant Adminstration 对话框中,单击 Create API Client
Create API Client Client Created 对话框中,会显示你的 Client IDClient Secret Client ID and Secret Dialog
  1. 要复制每个值,请单击其旁边的 copy icon 或者,单击 Save to File 以下载包含这两个值的 TXT 文件
重要! 密钥值仅在创建客户端时显示一次,因此需要立即进行保存。
  1. 单击 Close
    将显示 Public API Client 页面。

创建其他公共 API 客户端

要创建其他公共 API 客户端,请按以下步骤操作:
  1. 在 Vantage 中,单击 Configuration
  2. Tenant Adminstration 对话框中,单击 Public API Client
  3. Public API Client 页面上,单击 New Client 下拉列表并单击 Add Client
New Client Dropdown Client Created 对话框中,将显示你的 Client IDClient Secret
  1. 要复制每个值,请单击其旁边的 copy icon 或者,单击 Save to File 下载包含这两个值的 TXT 文件
Important! Secret 值仅在创建客户端时显示一次,因此必须立即保存。
  1. 单击 Close
    将显示 Public API Client 页面。

配置公共 API 客户端

创建公共 API 客户端后,需要对其进行配置。 要编辑公共 API 客户端设置,请单击客户端名称,或按客户端名称或应用程序主体角色进行搜索。 要配置公共 API 客户端,请执行以下步骤:
  1. Client Name 字段中输入新公共 API 客户端的名称。
OAuth 2.0 Configuration
  1. 要创建新的密钥,请单击 Add Secret。默认情况下,密钥的有效期为 6 个月。您可以更改过期时间,最长可设置为 36 个月。
  2. 要添加新的重定向 URL,请单击 Add Redirect URL
  3. OAuth 2.0 Flows Settings 部分配置允许的身份验证流。
    注意: 配置外部身份提供程序时,此流不起作用。
    您可以选择多个流:
    • Allow Authorization Code Flow。允许使用这种安全的身份验证机制进行身份验证,其中应用程序不会将身份验证请求路由到用户,而是直接发送给 Vantage 授权服务器。授权服务器随后验证用户凭据,并向客户端提供授权码。Authorization Code Flow 对所有 Vantage API 客户端启用。如有需要:
      • 选择 Require PKCE for Authorization Code Flow 选项。此选项可在对公共客户端授权时增强安全性,使 Vantage 能够验证请求访问令牌的应用程序与发起身份验证的应用程序是同一个。
    • Allow Resource Owner Password Credentials Flow。允许用户使用其用户名和密码进行身份验证。这意味着应用程序可以访问用户的密码,因此需要用户与应用程序之间具有高度信任。
    • 选择 Allow issuing refresh tokens to refresh access tokens。此选项允许签发刷新令牌以获取更新的访问令牌。应用程序可以使用刷新令牌请求新的访问令牌,而无需与用户交互。应用程序必须安全存储刷新令牌,因为它们允许用户保持已通过身份验证的状态。
  4. Allow client credentials flow。允许应用程序使用 OAuth 2.0 Client Credentials 流进行授权,从而获得对 Vantage API 的访问权限。分配给应用程序的角色由 Allow client credentials flow 下方的 Manage Roles 设置决定。应用程序将以指定的角色登录 Vantage。
  5. 配置 Token Lifetime Settings
    • Access Token. 定义签发的访问令牌允许用户访问 Vantage 的时间段。访问令牌的默认有效期为 24 小时。
    • Refresh Token. 定义从首次签发访问令牌开始计算的固定时间段,在此期间,签发的刷新令牌可用于续订访问令牌。刷新令牌的默认有效期为 30 天。
有关身份验证流的详细信息,请参阅 Authentication

删除公共 API 客户端

要删除客户端,请单击相应的图标,然后单击 Delete Client(删除客户端) Delete Client