管理 API を使用して組織を管理する

API キーを使用すると、管理 API によって組織を管理できます。組織 REST API による組織設定の更新、ユーザー管理 REST API によるユーザー アカウントの管理、分類 REST API による組織内のデータの分類ができるほか、管理者コントロール REST API を使ったデータ コンプライアンスの安全確保、認証ポリシーの管理、リソースへのアクセスが可能です。

任意のクライアントで API にリクエストを行うには、API キーを作成する必要があります。

API キー スコープとは

An API scope allows you to define the levels of access to data in your Atlassian apps. When you create an API key, you need to choose the access level for the API key. You can can create an API key with or without scopes. Scopes allow you to choose the actions an API key can perform in your Atlassian organization.

一部の API ではスコープのみを選択できます。使用可能なスコープについては、API ドキュメンテーションを確認してください。

スコープを持つ API キーを作成する

API キーを作成するときに、キーの目的を説明する名前を付けます。API キーの期限は 1 年以内です。API キーは、さまざまな統合に対応するために、固定長の値ではなく可変長の値をサポートしています。スコープを持つ API キーは、組織内の特定のアクションしか実行できないため安全です。

スコープを持つ API キーを作成するには、次の手順を実行します。

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [設定] > [API キー] の順に選択します。

3. [API keys with scopes (スコープを持つ API キー)] を選択します。

4. [API キーを作成] を選択します。

5. API キーを覚えやすい名前を入力します。

6. API キーの有効期限を選択します。キーの期限は 1 年以内です。

7. API のスコープを選択して、API キーが組織内で行えることを選択します。

8. API キー スコープの情報を確認します。

9. [作成] を選択して API キーを保存します。

10. API キーをコピーして安全な場所に保存します。後から API キーを復旧することはできません。セキュリティ対策として、API キーの値は保存しません。

スコープのない API キーを作成する

スコープのない API キーは、すべてのアトラシアンの管理 API にアクセスできます。スコープを持つ API キーを使用すると、API 呼び出しのアクセスを指定できます。この API キーはすべてにアクセスできるため、セキュリティ上のリスクが生じる可能性があります。
スコープのない API キーを作成する方法は次のとおりです。

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [設定] > [API キー] の順に選択します。

3. [API キーを作成] を選択します。

4. [API keys without scopes (スコープのない API キー)] を選択します。

5. [API キーを作成] を選択します。

6. API キー スコープの情報を確認します。

7. [作成] を選択して API キーを保存します。

8. API キーをコピーして安全な場所に保存します。後から API キーを復旧することはできません。セキュリティ対策として、API キーの値は保存しません。

API キーを取り消す

API キーを取り消すには:

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [設定] > [API キー] の順に選択します。

3. API キーの横にある [取り消し] を選択します。