この記事は無料の教室ライセンスをご利用の組織向けです。組織で法人向け商用ライセンスをご利用の場合は、すべて機能強化された新しい JetBrains Central Console 内で管理します。詳細な手順については、JetBrains Central Console ドキュメントをご覧ください。

JetBrains Account API を使用すると、組織のライセンスとユーザーアカウントを自動的に管理することができます。

この API は以下の目的で使用できます。

• ライセンスの詳細の取得
• ライセンスの割り当てまたは取り消し
• Team 間でのライセンスの移管
• ユーザーアカウントの作成または削除

JetBrains Account API リファレンス

API メソッドの全リストについては、JetBrains Account API リファレンスをご覧ください。

アカウント管理機能は、検証済みドメインをお持ちの組織のみが利用できます。

API のアクセスレベル

Organization プロファイルのロールによって、JetBrains Account UI で操作できる内容、API 経由でアクセスできる情報、情報を変更できるかどうかが決定します。 

API の有効化または無効化

API を有効にするには:

1. JetBrains Account にログインします。
2. 左のメニューにある Organization（組織） 名をクリックします。
   
3. 表示されるメニューで、Administration（管理）を選択します。
   
4. JetBrains Account API セクションで Enable API（API の有効化）をクリックします。
   
    

これにより、すべての管理者と閲覧者に API アクセスが付与されます。アクセスが付与されたユーザーは個人の API トークンを生成し、各自のロールに応じて Organization または Team のプロファイルに API 経由でアクセスできるようになります。

API の無効化

API を無効にするには、上記の手順のステップ 1～3 を実行してから Disable API（API を無効化）をクリックします。これにより、Organization の全員に対し API が無効になります。

API を無効化すると、API メソッドによる Organization プロファイルへのアクセスがブロックされますが、生成済みのトークンが無効になることはありません。後でもう一度 API を有効にする場合は、それらのトークンを使用することができます。詳細は、「トークンの有効期間」をご覧ください。

API アクセストークンの管理

Organization プロファイルのロールによって API アクセスが付与されている場合、個人のアクセストークンを生成し、必要に応じて再生成または無効化できます。 Organization と Team の管理者は、それぞれの Organization または Team 内の他のユーザーが生成したトークンを管理することもできます。 

個人の API トークンの管理

API を使用するには、個人のアクセストークンが必要です。トークンはいつでも生成、再生成、または無効化できます。トークンはアカウントに紐づけられているため、そのトークンを使って行われるすべての API リクエストはそのトークンのユーザーにリンクされます。 API アクセスを持つ Organization の他のメンバーも自分のトークンを生成できます。 

個人のトークンを生成する

1. Organization 内で JetBrains Account API が有効化されていることを確認します。
2. JetBrains Account にログインします。
3. 左側のメニューで、ロールに応じて以下のいずれかを選択してください。
   • Organization 管理者または閲覧者の場合は、Organization の名前をクリックします。
     
   • Team 管理者の場合は、Team 名をクリックします。
     
4. Administration（管理）ページの JetBrains Account API セクションで、Generate access token（アクセストークンの生成）をクリックします。
   

5. ダイアログがポップアップ表示されると、トークンを確認できます。セキュリティ上の理由により、このトークンは一度しか確認できません。したがって、ダイアログを閉じる前に安全な場所に必ず保存してください。 
   

   トークンは誰とも共有してはいけません。不正に使用された場合は直ちに無効化するか、新しいトークンを生成してください。

新しい個人のトークンを生成する

以下の場合には、新しい個人のトークンを生成する必要になる可能性があります。

• 現在のトークンにアクセスできなくなった。
• トークンが不正に使用された。

新しいトークンを生成するには:

1. 個人のトークンの生成手順のステップ 1～3 を実行します。
2. 管理ページの JetBrains Account API セクションで、Generate new token（新しいトークンの生成）をクリックします。
   
3. 確認ダイアログがポップアップ表示されたら、もう一度 Generate new token（新しいトークンの生成）をクリックします。
4. 次のポップアップダイアログで、新しいトークンが表示されます。セキュリティ上の理由により、このトークンは一度しか確認できません。したがって、ダイアログを閉じる前に安全な場所に必ず保存してください。

新しいトークンを生成すると、古いトークンは直ちに無効化されます。 JetBrains Account API を使用するすべてのアプリケーションでトークンを必ず更新してください。

個人のアクセストークンを無効化する

API にアクセスする必要がなくなったら、以下の手順に従ってトークンを無効化してください。

1. トークンの生成手順のステップ 1～3 を実行します。
2. Administration（管理）ページの API セクションで、Invalidate token（トークンの無効化）をクリックします。
   
3. 確認ダイアログがポップアップ表示されたら、もう一度 Invalidate token（トークンの無効化）をクリックします。

他のユーザーが生成した API トークンの管理

Organization または Team の管理者は、Organization または Team の他のメンバーが生成した API トークンの表示と取り消しを行えます。

Organization 全体の API トークンの表示と取り消し

1. 上記の手順にあるステップ 1～3 を実行して Oragnization 管理ページを開きます。
2. 管理ページ内で Users with access to company licenses（会社ライセンスにアクセスできるユーザー）まで下にスクロールします。
3. API token（API トークン）の列に、Organization 内でトークンを生成した全メンバーが表示されます。
4. トークンを取り消すには、テーブルからユーザーを探して Revoke（取り消す）をクリックします。
   

Team 固有の API トークンの表示と取り消し

1. トークンの生成手順にあるステップ 1～3 を実行して Team 管理ページを開きます。
2. 管理ページ内で、Team Administration（Team の管理）セクションまで下にスクロールします。
3. API token（API トークン）の列に、Team 内でトークンを生成した全メンバーが表示されます。
4. トークンを取り消すには、テーブルからユーザーを探して 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 パラメーターに指定します。