JetBrains Account API
透過 JetBrains Account API,您可以自動管理組織的授權和使用者帳戶。
您可以使用 API 來:
- 獲取授權詳細信息
- 分配或撤銷授權
- 在團隊之間轉移授權
- 創建或刪除用戶帳戶
JetBrains Account API 參考資料
查看完整的 API 方法列表,請參考 JetBrains Account API 參考資料。
請注意,帳戶管理功能僅對擁有已驗證網域的組織可用。
API 訪問級別
您在組織檔案中的角色決定了您可以在 JetBrains Account 使用介面中執行哪些操作,可以通過 API 訪問哪些信息,以及是否允許更改。
| 角色 | 您可以在 JetBrains Account 使用介面中執行的操作 | 您可以通過 API 訪問的內容 | API 訪問級別 |
|
整個組織檔案 |
完整訪問 |
|
|
您的團隊 |
完整訪問 |
|
|
觀察者和主要聯絡人 |
整個組織檔案 |
只讀 |
啟用或停用 API
| 🔒 所需權限:組織管理員。 |
如何啟用 API:
- 登入您的 JetBrains Account。
- 在左側選單裡,點擊您的組織名稱。
- 在選單中,選擇 Administration
(管理)。 -
在 API 區段中,點擊 Enable API(啟用 API)。
這將允許所有管理員、觀察者和主要聯絡人使用 API。 他們能夠產生個人 API 令牌,並在根據他們的角色透過 API 存取組織或團隊的授權帳戶。
進用 API
要禁用 API,請遵循 以上說明的步驟 1–3,然後點選 Disable API(禁用 API)。 這將停止組織中所有人對 API 的使用。
停用 API 將阻止通過 API 方法訪問組織檔案,但它 不會使已生成的令牌失效。 如果您稍後重新啟用 API,那些令牌仍將有效。 請參閱令牌生命週期以獲取詳細信息。
管理 API 訪問令牌
如果您的角色賦予您 API 訪問權限,您可以生成個人訪問令牌並在需要時重新生成或刪除。 組織和團隊管理員也可以管理由其他人生成的令牌。
管理您的個人 API 令牌
要使用 API,您需要一個個人訪問令牌。 您隨時可以生成、重新生成或刪除它。 您的令牌與您的帳戶相關聯,因此任何用該令牌進行的 API 請求都將與您相連。 其他有 API 訪問權限的組織成員也可以生成自己的令牌。
生成個人令牌
- 確保您的組織中已啟用 JetBrains Account API。
- 登入您的 JetBrains Account。
- 在左側的菜單中,根據您的角色選擇以下選項之一:
- 如果您是組織管理員、觀察者或主要聯絡人,點擊您的組織名稱:
- 如果您是組的管理員,點擊您的組名稱:
- 如果您是組織管理員、觀察者或主要聯絡人,點擊您的組織名稱:
- 在管理頁面的 API 部分,點選 Generate Token(生成令牌)。
-
當對話框出現時,您將看到您的令牌。 出於安全原因,我們只顯示一次。在關閉對話方塊之前,請務必將其保留在安全位置。
重新產生個人令牌
您可能需要在以下情况下重新生成个人令牌:
- 您無法訪問您當前的令牌。
- 您的令牌被洩露。
要生成新令牌:
- 請依照生成個人令牌的指示步驟 1–3。
- 在管理頁面的 API 部分,點選 Re-Generate Token(重新生成令牌)。
- 當確認對話框彈出時,請再次點選 Re-Generate Token(重新生成令牌)。
- 在下一個彈出對話框中,您將看到新的令牌。 出於安全原因,我們只顯示一次。在關閉對話方塊之前,請務必將其保留在安全位置。
如果您重新產生令牌,舊的令牌將立即失效。 請確保更新使用 API 的任何應用程式中的令牌。
刪除個人訪問令牌
如果您不再需要 API 訪問,請按以下步驟刪除您的令牌:
- 請依照生成您令牌的指示步驟 1–3。
- 在管理頁面的 API 部分,點選 Remove Token(刪除令牌)。
- 當確認對話框彈出時,請再次點選 Remove Token(刪除令牌)。
管理由他人生成的 API 令牌
作為組織或團隊管理員,您可以查看並撤銷其他成員產生的 API 令牌。
查看和撤銷組織範圍內的 API 令牌
| 🔒 所需權限:組織管理員。 |
- 請依照上述說明中的步驟 1–3 執行操作,以開啟組織管理頁面。
- 在管理頁面中,向下滾動至 Users with access to company licenses(可使用公司授權的使用者)。
- 在 API 令牌欄,您將看到所有生成令牌的組織成員。
- 要撤銷令牌,請在表中找到使用者並點選 Revoke(撤銷)。
查看和撤銷特定團隊的 API 令牌
- 請依照生成您令牌的指示步驟 1–3以開啟團隊管理頁面。
- 在管理頁面中,向下滾動至 Team Administration 部分。
- 在 API 令牌欄,您將看到所有生成令牌的團隊成員。
- 要撤銷令牌,請在表中找到使用者並點選 Revoke(撤銷)。
令牌生命週期
一旦發出,JetBrains Account API 令牌具有無限期的生命週期。
每個用戶獲得一個令牌,即使他們有多個角色。 除非他們重新生成或刪除它,令牌將保持活動狀態,只要他們至少保留一個角色。 如果他們失去所有角色,令牌將自動撤銷。
如果您禁用 API並稍後重新啟用,任何以前生成的令牌將仍然有效,除非您刪除或重新生成它們。
如果您的個人令牌被洩露,請立即重新生成或刪除它。 如果其他人的令牌被洩露,請撤銷它。
使用 API 方法
查看完整的可用方法列表,請參考JetBrains Account API 參考資料。 請注意,帳戶管理功能僅對擁有已驗證網域的組織可用。
要使用 API 方法,您需要兩個參數:
1. 您的客戶 ID 用于 X-Customer-Code
您的 JetBrains 客戶 ID 是一個與您組織的訂單和授權有關的唯一識別碼。 您可以在您的 JetBrains Account 中找到它。
在請求中使用此值做為 X-Customer-Code 參數。
2. 您的訪問令牌用於 X-Api-Key
按照上述步驟生成您的個人令牌。 使用它作為 X-Api-Key 參數。