建立授权 API 连接时,需要使用 API 令牌对自己进行身份验证。以前称为 OAuth 刷新令牌的 API 令牌用于交换访问令牌,并按组织授权访问。您可以从 Cloud Services Console 中的帐户页面或通过 VMware Cloud Services 生成 API 令牌。

令牌是使用可提取字母数字字符的特殊算法生成的。每个令牌都是一个唯一的 65 个字符的组合。生成令牌时,您可以确定令牌的持续时间和范围:
  • 令牌的生存时间 (TTL) 范围可以是几分钟到几个月,也可以设置为永不过期。默认持续时间为六个月。
  • 范围提供了一种方法,可对令牌有权访问组织中的哪些区域实施控制,即组织中的哪些角色以及哪些服务和权限级别。

前提条件

确保 API 令牌的存储位置安全且受保护。

过程

  1. Cloud Services Console工具栏上,单击您的用户名,然后选择我的帐户 > API 令牌
  2. 单击生成新的 API 令牌链接。
  3. 输入令牌的名称。
  4. 指定令牌的所需使用期限。
    注: 如果遭到入侵,不会过期的令牌可能会带来安全风险。如果发生这种情况,必须撤销令牌。
  5. 定义令牌的范围。您的选择必须基于您的用户帐户支持的角色。
    范围 描述
    组织角色 组织角色决定了用户对组织资源的访问权限。
    • 为您的 API 令牌选择一个或多个组织角色。
    服务角色 服务角色内置在授予对 VMware Cloud services 的访问权限的预定义权限集中。
    • 使用服务名称旁边的箭头图标可展开可用于该服务的角色,然后为您的 API 令牌选择一个或多个服务角色。
    权限 某些服务支持为服务角色分配一组有限的可用权限,从而进行更精细的选择。
    • 选择服务角色时,可用权限将显示在表的右侧。为您的 API 令牌选择相关的服务权限。
    如果需要,您可以选择 所有角色,并授予您对所有组织和服务角色的令牌访问权限。
    注: 即使您为令牌分配 所有角色访问权限,该令牌也只有您的用户帐户支持的访问角色。要查看您拥有的组织和服务角色,请从 我的帐户页面中选择 我的角色选项卡。
  6. (可选)选中 Open ID 复选框以检索具有扩展用户详细信息的 Open ID 合规令牌。
  7. (可选)设置电子邮件首选项,以便在令牌即将过期时接收提醒。
  8. 单击生成
  9. 将令牌凭据保存到安全位置,以便可以检索供以后使用。
    出于安全原因,在生成令牌后,我们仅在“API 令牌”页面上显示令牌的名称,而不是令牌凭据。这意味着您无法再通过复制此页面中的凭据来重用令牌。
  10. 单击继续
    除了 API 令牌之外,您还可以使用 OAuth 应用程序对应用程序进行身份验证。要了解何时使用 OAuth 应用程序,而不使用 API 令牌,请参见 OAuth 应用程序与 API 令牌的区别

示例: 使用 API 令牌与 VMware Cloud Services API 交互

通过将 API 令牌交换为身份验证令牌可以使用 API 令牌与我们的 API 进行交互。
  1. 生成 API 令牌。
  2. https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize 执行 POST
  3. 在标头中,包括以下请求:
    • accept: application/json
    • content type: application/x-www-form-urlencoded/
  4. 在正文中,包括 refresh_token={token value} 请求。
  5. 执行脚本的 HTTP 调用时,在 csp-auth-token 标头中使用身份验证令牌。