建立授权 API 连接时,需要使用 API 令牌对自己进行身份验证。API 令牌以前称为 OAuth 刷新令牌,按组织授予访问权限。

令牌有效期为 6 个月,如果您要在令牌过期后继续使用依赖令牌的 API,则必须重新生成令牌。如果觉得令牌可能被盗用,您可以撤销令牌以防止未经授权的访问。生成新令牌可以续订授权。

可以随时重新生成令牌。如果重新生成令牌,则会撤销先前令牌的所有实例。如果您已使用令牌(例如,在您的一个脚本中使用了令牌),请记得将其替换为新生成的令牌。

过程

  1. 在 VMware Cloud Services 工具栏中,单击您的用户名,然后选择我的帐户 > API 令牌
  2. 输入令牌的名称。
  3. 指定令牌的使用期限。
  4. 定义令牌的范围。

    范围提供了一种方法,可对令牌有权访问组织中的哪些区域实施控制,即组织中的哪些角色以及哪些服务和权限级别。如果需要,您可以选择所有角色,并授予您对所有组织和服务角色的令牌访问权限。

  5. 选中请求 ID复选框,获取有关授权您应用程序的用户的信息。
  6. 单击生成
  7. 将令牌凭据保存到安全位置,以便可以检索供以后使用。
    出于安全原因,在生成令牌后,我们仅在“API 令牌”页面上显示令牌的名称,而不是令牌凭据。这意味着您无法再通过复制此页面中的凭据来重用令牌。
  8. 单击继续
    除了 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 标头中使用身份验证令牌。