Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

创建 API 令牌

API 令牌包含身份验证信息,并绑定到特定用户或整个组织。API 令牌将有关用户或组织的标识信息发送到 API 服务器,以指示用户是否有权访问 API,以确保安全性。

与许多其他 API 提供商一样,瞻博网络 Mist 提供了一种生成用于身份验证的 API 令牌的方法(在 HTTP 标头中)。在考虑令牌时,瞻博网络 Mist 可以互换使用术语 “令牌 ”和 “密钥 ”。

在瞻博网络 Mist 中,有两种类型的 API 令牌:
  • 组织令牌

    在构建可自动为组织工作的应用程序时,组织令牌非常有用。多个用户需要访问应用程序,因此将使用相同的组织令牌进行身份验证。

    • 令牌保留在 Mist 组织下。
    • 令牌未绑定到任何特定用户,这意味着访问权限不依赖于任何用户对组织的访问权限。
    • 支持 N 个 组织令牌,这些令牌可以具有不同的权限。
    • 令牌只能用于该特定组织。
    • 速率限制由单个令牌完成。例如,如果 OrgToken1 消耗 5000 次 API 调用并达到速率限制,则 OrgToken2 不会受到影响。
  • 用户令牌

    当您需要自己进行身份验证时(例如,在运行脚本时),用户令牌非常有用。

    • API 令牌采用与分配的用户的帐户权限相同的权限。

    • 令牌绑定到特定用户,这意味着访问权限与用户对组织的访问权限直接相关。
    • 令牌可用于用户有权访问的任何托管服务提供商 (MSP) 或组织。
    • 支持 N 个令牌,这些令牌都具有与用户帐户相同的权限。
    • 速率限制由与用户绑定的帐户完成。例如,如果用户令牌 1 消耗 5000 次 API 调用并达到速率限制,则用户令牌 2 和帐户登录到 GUI 将受到影响。

您可以通过 Mist 门户或 REST API 资源管理器创建 API 令牌。

在 Mist 门户中创建组织令牌

  1. 从瞻博网络 Mist 门户的左侧菜单中,选择组织>管理员>设置
  2. 向下滚动到 API 令牌部分,然后单击创建令牌
  3. 选择访问级别以定义令牌的权限。

  4. 单击生成
  5. 单击密钥字段旁边的复制按钮并将其存放在某个地方以便妥善保管。
    注意:

    您唯一一次看到完整的未截断密钥是在创建时。您将无法再次看到完整的密钥。如果放错了密钥,则必须创建一个新密钥。

  6. 单击窗口底部的完成
  7. 单击页面右上角附近的保存

在 Mist 门户中创建用户令牌

您可以从 Mist 门户中的“我的帐户”页面生成 API 用户令牌。

要生成 API 用户令牌,请执行以下操作:

  1. 在瞻博网络 Mist 门户的右上角,单击瞻博网络 Mist 帐户图标,然后单击我的帐户
  2. 在 API 令牌部分,单击创建令牌。如果为组织启用了单点登录,则无法创建 API 用户令牌。
  3. 输入令牌的名称,然后单击生成。生成的密钥是用户 API 令牌。
  4. 单击“密钥”字段旁边的复制按钮。

    确保将密钥存放在某个地方以便妥善保管,因为您将无法再次看到完整的密钥。如果密钥放错了位置,则需要创建一个新密钥。

  5. 单击完成
    注意:

    如果需要删除用户令牌,请在“ 我的个人资料” 页的“API 令牌”部分中单击该令牌,然后单击“编辑令牌”页中的 “删除 ”。

使用 REST API 资源管理器创建用户或组织令牌

  1. 登录瞻博网络 Mist 门户。
    注意:

    必须登录到门户才能使用 REST API 资源管理器。

  2. 打开一个新的浏览器窗口并粘贴您的 URL:{api-host}/api/v1/self/apitokens
    注意:

    要代替 {api-host},您需要使用全局区域的 API 终端节点。请参阅 API 终端节点和全局区域

    REST API 资源管理器是用于令牌控制的 API 页面。您可以在此处创建、读取、更新和删除令牌和令牌信息。此页面最初显示已创建的令牌。

    此页面还允许您和其他用户直接从浏览器进行 API 调用。当媒体 类型:应用程序/json 已选择为默认值时,将执行 GET 请求以显示令牌列表。对于以前创建的任何令牌,将显示截断的密钥。

  3. 单击“开机自检”。

    响应将类似于以下示例:

  4. 复制密钥(令牌)并将其存储以便保管。
    注意:

    创建密钥后,瞻博网络 Mist API 将再也不会在任何位置完整显示实际令牌(密钥)。离开此页面并返回后,将显示该密钥,但采用截断版本。您应该将此密钥视为密码并将其存储在安全的地方。如果丢失此密钥,则需要创建一个新密钥。