JetBrains Account API
JetBrains Account API を使って、ライセンスの管理と JetBrains Account からのライセンス使用状況データの取得を自動的に行えます。
API メソッドでは、ライセンス情報の取得、ライセンスの割り当てと取り消し、チーム間でのライセンスの移動が可能です。 API メソッドへのアクセスレベルは、JetBrains Account ロールで定義されています。 詳細については、API リファレンスをご覧ください。
ロール
API には 3 つのアクセスレベルがあり、Organization (組織)で割り当てられたロールが反映されます。
- Organization(組織)管理者は、API の有効化と無効化、管理者自身のトークンの生成と再生成、他の Organization 管理者を含む組織内のユーザーのアクセストークンの取り消しを行えます。
- Team(チーム)管理者は、その Team の他の管理者を含むユーザーのアクセストークンの生成、再生成、および削除を行えます。
- Viewers(ビューアー)およびPrimary contacts(主要連絡先)は、自身のアクセストークンの生成、再生成、および削除を行えます。 Viewer と Primary contact アクセストークンでは、API への読み取り専用アクセスが提供されます。
API を有効にするには
API の有効化は、以下の手順で行います。
- Organization 管理者の資格情報を使って、JetBrains Account にログインします。
Team 管理者は、API を有効化または無効化できません。 - 左側のメニューにある Organization の名前をクリックし、Administration(管理)をクリックします。
-
Enable API(API を有効化)をクリックします。
これにより、API がすべての Organization と Team の管理者だけでなく、Viewer と Primary contacts にも有効になります。 割り当てられたロールのあるすべてのユーザーが、トークンを生成できるようになります。
API を無効にするには
API を無効にするには、上記の手順 1 と 2 を実行して、Disable API (API の無効化) をクリックします。
このボタンによって、すべての管理者、Viewer、および Primary Contact の API が無効化されます。
API メソッドにアクセスするには
メソッドにアクセスするには、2 つのパラメーターが必要です。
1. X-Customer-Code
パラメーターに指定されるお客様コード
お客様コードは、一意の Organization ID です。 お客様コードは、JetBrains Account にアクセスすると表示される Organization 名の横にある番号です。
この値を X-Customer-Code
パラメーターに渡します。
2. X-Api-Key
パラメーターに指定されるアクセストークン
アクセストークンは、以下の手順で生成します。
- JetBrains Account にアクセスします。
- 左側のメニューにある Organization または Team の名前をクリックし、Administration(管理)をクリックします。
-
Generate Token(トークンを生成)をクリックします。
- トークンが、ポップアップダイアログに表示されます。 セキュリティ上の理由により、このトークンは一度しか表示されません。 このダイアログを閉じる前に、トークンを安全な場所に保管してください。 トークンは誰とも共有してはいけません。
トークンを紛失した場合は、再生成する必要があります。 新しいトークンを生成すると、前のトークンが無効になります。
取得したトークンを X-Api-Key
パラメーターに渡します。
トークンの有効期間
API を無効にしてから有効にする場合、手動で新しい API を生成しない限り、アクセストークンはそのまま有効となります。
複数のロールを割り当てられている場合でも、各ユーザーのトークンは 1 つしかありません。 ユーザーが少なくとも 1 つのロールを維持する限り、トークンは同じままです。 ユーザーがすべてのロールを失うと、そのアクセストークンは自動的に取り消されます。