JetBrains Account API
JetBrains Account API を使用すると、組織のライセンスとユーザーアカウントを自動的に管理することができます。
この API は以下の目的で使用できます。
- ライセンスの詳細の取得
- ライセンスの割り当てまたは取り消し
- Team 間でのライセンスの移管
- ユーザーアカウントの作成または削除
JetBrains Account API リファレンス
API メソッドの全リストについては、JetBrains Account API リファレンスをご覧ください。
アカウント管理機能は、検証済みドメインをお持ちの組織のみが利用できます。
API のアクセスレベル
Organization プロファイルのロールによって、JetBrains Account UI で操作できる内容、API 経由でアクセスできる情報、情報を変更できるかどうかが決定します。
| ロール | JetBrains Account UI で操作できること | API 経由でアクセスできる情報 | API のアクセスレベル |
|
Organization プロファイルの全情報 |
フルアクセス |
|
|
あなたのチーム |
フルアクセス |
|
|
閲覧者と主要連絡先 |
Organization プロファイルの全情報 |
読み取り専用 |
API の有効化または無効化
| 🔒 次の権限が必要です: Organization 管理者。 |
API を有効にするには:
- JetBrains Account にログインします。
- 左のメニューにある Organization(組織) 名をクリックします。
- 表示されるメニューで、Administration(管理)を選択します。
-
API セクションで Enable API(API を有効化)をクリックします。
これにより、すべての管理者、閲覧者、および主要連絡先に API アクセスが付与されます。 API 経由で、個人の API トークンの生成と、それぞれのロールに応じて、Organization または Team のプロファイルへのアクセスが可能になります。
API の無効化
API を無効にするには、上記の手順のステップ 1~3 を実行してから Disable API(API を無効化)をクリックします。 これにより、Organization の全員に対し API が無効になります。
API を無効にすると、API メソッドによる Organization プロファイルへのアクセスがブロックされますが、すでに生成されたトークンが無効になることはありません。 後でもう一度 API を有効にする場合は、それらのトークンを使用することができます。 詳細は、「トークンの有効期間」をご覧ください。
API アクセストークンの管理
Organization プロファイルのロールによって API アクセスが付与されている場合、個人のアクセストークンの生成と、必要に応じて再生成または削除を行えます。 Organization と Team の管理者は、それぞれの Organization または Team 内の他のユーザーが生成したトークンを管理することもできます。
個人の API トークンの管理
| 🔒 次の権限が必要です: Organization 管理者、Team 管理者、または主要請求連絡先。 |
API を使用するには、個人のアクセストークンが必要です。 いつでも生成、再生成、または削除することができます。 トークンはアカウントに紐づけられているため、そのトークンを使って行われるすべての API リクエストはそのトークンのユーザーにリンクされます。 API アクセスを持つ Organization の他のメンバーも自分のトークンを生成できます。
個人のトークンを生成する
- Organization 内で JetBrains Account API が有効化されていることを確認します。
- JetBrains Account にログインします。
- 左側のメニューで、ロールに応じて以下のいずれかを選択してください。
- Organization 管理者、閲覧者、または主要連絡先の場合は、Organization 名をクリックします。
- Team 管理者の場合は、Team 名をクリックします。
- Organization 管理者、閲覧者、または主要連絡先の場合は、Organization 名をクリックします。
- 管理ページの API セクションで、Generate Token(トークンを生成)をクリックします。
-
ダイアログがポップアップ表示されると、トークンを確認できます。 セキュリティ上の理由により、このトークンは一度しか確認できません。したがって、ダイアログを閉じる前に安全な場所に必ず保存してください。
個人のトークンを再生成する
以下の場合には、個人のトークンを再生成する必要がある場合があります。
- 現在のトークンにアクセスできなくなった。
- トークンが不正に使用された。
新しいトークンを生成するには:
- 個人のトークンの生成手順のステップ 1~3 を実行します。
- 管理ページの API セクションで、Re-Generate Token(トークンを再生成)をクリックします。
- 確認ダイアログがポップアップ表示されたら、もう一度 Re-Generate Token(トークンを再生成)をクリックします。
- 次のポップアップダイアログで、新しいトークンが表示されます。 セキュリティ上の理由により、このトークンは一度しか確認できません。したがって、ダイアログを閉じる前に安全な場所に必ず保存してください。
トークンを再生成すると、古いトークンはすぐに無効になります。 API を使用するすべてのアプリケーションでトークンを必ず更新してください。
個人のアクセストークンを削除する
API にアクセスする必要がなくなったら、以下の手順に従ってトークンを削除してください。
- トークンの生成手順のステップ 1~3 を実行します。
- 管理ページの API セクションで、Remove Token(トークンを削除)をクリックします。
- 確認ダイアログがポップアップ表示されたら、もう一度 Remove Token(トークンを削除)をクリックします。
他のユーザーが生成した API トークンの管理
Organization または Team の管理者は、Organization または Team の他のメンバーが生成した API トークンの表示と取り消しを行えます。
Organization 全体の API トークンの表示と取り消し
| 🔒 次の権限が必要です: Organization 管理者。 |
- 上記の手順にあるステップ 1~3 を実行して Oragnization 管理ページを開きます。
- 管理ページ内で Users with access to company licenses(会社ライセンスにアクセスできるユーザー)まで下にスクロールします。
- API token(API トークン)の列に、Organization 内でトークンを生成した全メンバーが表示されます。
- トークンを取り消すには、テーブルからユーザーを探して Revoke(取り消す)をクリックします。
Team 固有の API トークンの表示と取り消し
| 🔒 次の権限が必要です: Organization 管理者または Team 管理者。 |
- トークンの生成手順にあるステップ 1~3 を実行して Team 管理ページを開きます。
- 管理ページ内で、Team Administration(Team の管理)セクションまで下にスクロールします。
- API token(API トークン)の列に、Team 内でトークンを生成した全メンバーが表示されます。
- トークンを取り消すには、テーブルからユーザーを探して Revoke(取り消す)をクリックします。
トークンの有効期間
一度発行されると、JetBrains Account API トークンは無期限で使用できます。
複数のロールがある場合でも、トークンはユーザーごとに 1 つ付与されます。 そのトークンを再生成または取り消さない限り、ユーザーに 1 つ以上のロールがある限り有効な状態が維持されます。 すべてのロールを失った場合、トークンは自動的に取り消されます。
API を無効化し、後でもう一度有効化すると、トークンが削除されたり再生成されたりしていない限り、以前に生成されたトークンが有効なままになります。
個人のトークンが不正にアクセスされた場合は、直ちに再生成または削除してください。 他の誰かのトークンが不正にアクセスされた場合は、取り消してください。
API メソッドの使用
利用できるメソッドの全リストについては、JetBrains Account API リファレンスをご覧ください。 アカウント管理機能は、検証済みドメインをお持ちの組織のみが利用できます。
API メソッドを使用するには、以下の 2 つのパラメーターが必要です。
1. X-Customer-Code に指定するあなたのカスタマー ID
JetBrains カスタマー ID は、組織の注文とライセンスに関連づけられている一意の識別子です。 JetBrains Account 内に記載されています。
この値をリクエストの X-Customer-Code パラメーターに指定します。
2. X-Api-Key に指定するアクセストークン
上記の手順を実行して個人のトークンを生成します。それを X-Api-Key パラメーターに指定します。