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，以确保安全性。

与许多其他 API 提供商一样，Juniper Mist 提供了一种生成用于身份验证的 API 令牌的方法（在 HTTP 标头中）。在考虑令牌时，Juniper Mist 可以互换使用 术语令牌 和 密钥 。

注意力：在 2026 年 9 月之前，所有集成都必须过渡到基于令牌的身份验证，以确保不间断的访问和支持。基本身份验证将于 2026 年 9 月弃用，以增强安全性并符合行业最佳实践。
在Juniper Mist中，有两种类型的 API 令牌：

  • 组织令牌

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

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

  • 用户令牌

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

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

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

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

在Mist门户中创建组织令牌

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

  4. 单击生成。
  5. 单击“密钥”字段旁边的复制按钮，并将其存储在某处以便妥善保管。
    注意：

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

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

在Mist门户中创建用户令牌

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

要生成 API 用户令牌，请执行以下作：

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

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

  5. 单击“完成”。
    注意：

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

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

  1. 登录到 Juniper Mist 门户。
    注意：

    必须登录到门户才能使用 REST API 资源管理器。
  2. 打开新的浏览器窗口并粘贴您的 URL：{api-host}/api/v1/self/apitokens。
    注意：

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

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

    此页面还使您和其他用户能够直接从浏览器进行 API 调用。在已选择 “媒体类型：applications/json ”作为默认值的情况下，将执行 GET 请求以显示令牌列表。对于任何以前创建的令牌，将显示截断的密钥。

  3. 单击 POST。

    响应将类似于此示例：

  4. 复制密钥（令牌）并将其存储起来以便妥善保管。
    注意：

    创建密钥后，Juniper Mist API 将再也不会在任何地方完整显示实际令牌（密钥）。离开此页面并返回后，密钥将出现，但以截断版本出现。您应该将此密钥视为密码并将其存储在安全的地方。如果丢失此密钥，则需要创建一个新密钥。
    注意：

    如果您计划与他人共享 Python 脚本，请确保不要将 API 令牌存储在脚本本身中，而是使用环境文件 （.mist_env） 来代替。环境文件在脚本中为你存储敏感信息，因此你不必直接在脚本中共享敏感信息。有关详细信息，请参阅 https://github.com/tmunzer/mist_library?tab=readme-ov-file#environment-file。