JetBrains Account API

通过 JetBrains Account API,您可以自动管理组织的许可证和用户帐户。

您可以使用 API:

  • 获取许可证详情
  • 分配或撤销许可证
  • 在团队之间转移许可证
  • 创建或删除用户帐户

JetBrains Account API 参考

有关 API 方法的完整列表,请参阅 JetBrains Account API 参考

请注意,帐户管理功能仅适用于具有已验证域名的组织。

API 访问级别

您在组织档案中的角色决定了您在 JetBrains Account 界面中可以执行的操作、可以通过 API 访问的信息和是否被允许更改。 

角色 您可以在 JetBrains Account 界面中执行的操作 您可以通过 API 访问的内容 API 访问级别

组织管理员

整个组织档案

完全访问

团队管理员

您的团队

完全访问

查看者和 主要联系人

整个公司组织授权帐户

只读

启用或禁用 API

🔒 所需权限:组织管理员

启用 API:

  1. 登录您的 JetBrains Account。
  2. 在左侧菜单中,点击您的组织名称。
    Enter organization profile
  3. 在出现的菜单中,选择 Administration
    Select administration
    (管理)。
  4. 在 API 部分, 点击 Enable API(启用 API)。
    Enable API

这将为所有管理员、查看者和主要联系人提供 API 访问权限。 他们能够生成个人 API 令牌,并在根据他们的角色通过 API 访问组织或团队的授权帐户。

禁用 API

要禁用 API,按照上面的步骤 1–3 ,然后点击 Disable API(禁用 API)。 这将禁用整个组织的 API。

Disable API

禁用 API 会阻止通过 API 方法访问组织资料,但它不会使已生成的任何令牌失效。 如果您稍后重新启用 API,这些令牌仍然有效。 详细信息请参见令牌生命周期

管理 API 访问令牌

如果您在组织资料中的角色赋予了 API 访问权限,您就可以生成个人访问令牌,并在需要时重新生成或删除它。 组织和团队管理员还可以在其组织或团队中管理他人生成的令牌。 

管理您的个人 API 令牌

🔒 所需权限:组织管理员团队管理员主要账单联系人

要使用 API,您需要一个个人访问令牌。 您可以随时生成重新生成删除它。 您的令牌绑定至您的帐户,因此使用该令牌进行的任何 API 请求都将关联到您。 其他具有 API 访问权限的组织成员也可以生成自己的令牌。 

生成个人令牌

  1. 确保您的组织已启用 JetBrains Account API
  2. 登录您的 JetBrains Account。
  3. 在左侧菜单中,根据您的角色选择以下之一:
    • 如果您是组织管理员、查看者或主要联系人,请点击组织名称:
      Enter organization profile
    • 如果您是团队管理员,请点击团队名称:
      Click on your team's name
  4. 在管理页面的 API 部分,点击 Generate Token(生成令牌)。
    Generate API access token
  5. 当对话框弹出时,您将看到您的令牌。 出于安全原因,我们只显示一次。在关闭对话框之前,请务必将其保留在安全位置。 
    API token shown in a popup

    不要与任何人共享您的令牌。 如果已被泄露,请立即将其重新生成移除

重新生成个人令牌

您可能需要在以下情况下重新生成个人令牌:

  • 您无法访问当前的令牌。
  • 您的令牌被泄露。

要生成新令牌:

  1. 按照生成个人令牌的说明中的步骤 1–3 进行操作。
  2. 在管理页面的 API 部分,点击 Re-Generate Token(重新生成令牌)。
    Regenerate API access token
  3. 当确认对话框弹出时,再次点击 Re-Generate Token (重新生成令牌)。
  4. 在下一个弹出对话框中,您将看到您的新令牌。 出于安全原因,我们只显示一次。在关闭对话框之前,请务必将其保留在安全位置。

如果您重新生成令牌,旧的令牌将立即失效。 确保在使用 API 的任何应用程序中更新您的令牌。

移除个人访问令牌

如果您不再需要 API 访问权限,请按照以下步骤移除您的令牌:

  1. 按照生成令牌的说明中的步骤 1–3 操作。
  2. 在管理页面的 API 部分,点击 Remove Token(删除令牌)。
    Remove API access token
  3. 当确认对话框弹出时,再次点击 Remove Token(删除令牌)。

管理他人生成的 API 令牌

作为组织或团队管理员,您可以查看并撤销其他成员生成的 API 令牌。

查看和撤销组织范围内的 API 令牌

🔒 所需权限:组织管理员
  1. 按照上述说明中的第 1–3 步执行操作,以打开组织管理页面。
  2. 在管理页面,向下滚动到 Users with access to company licenses(可使用公司许可证的用户)。
  3. API 令牌 列中,您将看到组织中所有已生成令牌的成员。
  4. 要撤销令牌,在表中找到用户并点击 Revoke(撤销)。
    Team administrator table with API tokens

查看和撤销特定团队的 API 令牌

🔒 所需权限:组织管理员团队管理员
  1. 按照生成令牌的说明中的第 1–3 步骤,打开团队管理页面。
  2. 在管理页面,向下滚动到 Team Administration (团队管理)部分。
  3. API 令牌 列中,您将看到团队中所有已生成令牌的成员。
  4. 要撤销令牌,在表中找到用户并点击 Revoke(撤销)。
    Team administrator table with API tokens

令牌生命周期

一旦发出, JetBrains Account API 令牌具有无限期的有效期。 

每个用户只能获得一个令牌,即使他们拥有多个角色。 除非他们重新生成移除该令牌,否则该令牌在他们保留至少一个角色期间保持激活。 若他们失去所有角色,该令牌将自动被撤销。

如果您禁用 API,然后稍后再次启用,除非您移除或重新生成它们,否则之前生成的令牌仍然有效。

如果您的个人令牌被泄露,立即将其重新生成移除。 如果他人的令牌被泄露,将其撤销

使用 API 方法

请参阅 JetBrains Account API 参考,以获取完整可用方法列表。 🔒 请注意,帐户管理功能仅适用于具有已验证域名的组织。

要使用 API 方法,您需要两个参数:

1. 您的 X-Customer-Code 客户 ID

您的 JetBrains 客户 ID 是与您组织的订单和许可证相关联的唯一标识符。 您可以在您的 JetBrains Account 中找到它

在请求中使用这个值作为 X-Customer-Code 参数。

2. 您的 X-Api-Key 访问令牌

按照上面的步骤生成个人令牌。 用于 X-Api-Key 参数。

34 人中有 16 人觉得有帮助

还有其他问题?

提交请求