API 令牌

您可以使用令牌访问 Orchestrator API，而不是使用基于会话的身份验证。作为操作员超级用户，您可以管理 API 令牌。您可以为用户创建多个 API 令牌。

注： 对于企业只读用户和 MSP 业务专家用户，不会激活基于令牌的身份验证。

默认情况下，将激活 API 令牌。如果要停用这些令牌，请转到操作员门户中的 系统属性 (System Properties)，并将 session.options.enableApiTokenAuth 系统属性的值设置为 False。

注： 操作员超级用户应手动从 Orchestrator 中删除非活动身份提供程序 (IdP) 用户，以防止用户通过 API 令牌进行未经授权访问。

用户可以根据其角色创建、吊销和下载令牌。

要管理 API 令牌，请执行以下操作：

1. 在操作员门户中，导航到管理 (Administration) > 用户管理 (User Management) > 用户 (Users)。
2. 选择一个用户，然后单击修改 (Modify)，或者单击该用户名的链接。转到 API 令牌 (API Tokens) 部分。

   

3. 单击新建 API 令牌 (New API Token)。

   

4. 在新建令牌 (New Token) 窗口中，输入令牌的名称 (Name) 和描述 (Description)，然后从下拉菜单中选择生命周期 (Lifetime)。
5. 单击保存 (Save)。将在 API 令牌 (API Tokens) 表中显示新令牌。最初，令牌的状态显示为挂起 (Pending)。在下载令牌后，状态将变为已启用 (Enabled)。
6. 要下载令牌，请选择该令牌，然后单击下载 API 令牌 (Download API Token)。
7. 要停用令牌，请选择该令牌，然后单击吊销 API 令牌 (Revoke API Token)。令牌状态将显示为已吊销 (Revoked)。
8. 单击 CSV 以使用 .csv 文件格式下载完整的 API 令牌列表。
9. 在令牌的生命周期结束时，状态将变为已过期 (Expired)。

注： 仅与令牌关联的用户可以下载该令牌，在下载后，仅显示令牌 ID。您只能下载一次令牌。在下载令牌后，用户可以将其作为请求的授权标头的一部分发送以访问 Orchestrator API。

以下示例显示了用于访问 API 的示例代码段。

curl -k -H "Authorization: Token <Token>"
  -X POST https://vco/portal/
  -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'

同样，您可以为合作伙伴管理员、企业客户和合作伙伴客户配置其他属性并创建 API 令牌。有关更多信息，请参阅：

• 《VMware SD-WAN 管理指南》中的“用户”主题
• 《VMware SD-WAN 合作伙伴指南》中的“用户”主题

以下是 API 令牌 (API Tokens) 部分中提供的其他选项：

选项	描述
搜索 (Search)	输入搜索词以在表格中搜索匹配的文本。使用高级搜索选项可缩小搜索结果的范围。
列 (Columns)	单击并选择要在页面上显示或隐藏的列。
刷新 (Refresh)	单击以刷新页面，从而显示最新的数据。