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

API keys allow you to manage your organization through the admin APIs. You can update organization settings with the organization REST APIs, manage user accounts with the user management REST APIs, classify data in an organization with the classification REST APIs, and secure data compliance, manage authentication policies, and access to resources with the admin control REST APIs.

To make requests to the API with the client of your choice, you need to create an API key.

What are API key scopes?

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.

You’re only able to select scopes for some APIs. Check API documentation for available scopes.

Create API key with scopes

When you create an API key, you give it a name that describes the purpose of the key. An API key can last no longer than a year. API keys support variable length values, not fixed length values, to accommodate different integrations. An API key with scopes is secure because it can only perform specific actions in your organization.

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

1. admin.atlassian.com に移動します。 複数の組織がある場合は、対象の組織を選択します。

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

3. Select API keys with scopes.

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

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

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

7. Select API scopes to choose what the API key can do in your organization.

8. Review your API key scope information.

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

10. Copy your API key and save it somewhere safe. You can't recover the API key later. As a security precaution, we don't store your API key value.

Create an API key without scopes

An API key without scopes can access all Atlassian Admin APIs. An API key with scopes allows you to specify the access for your API calls. This API key may present a security risk because it can access everything.
To create API key without scopes:

1. admin.atlassian.com に移動します。 複数の組織がある場合は、対象の組織を選択します。

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

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

4. Select API keys without scopes.

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

6. Review your API key scope information.

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

8. Copy your API key and save it somewhere safe. You can't recover the API key later. As a security precaution, we don't store your API key value.

API キーを取り消す

API キーを取り消すには:

1. admin.atlassian.com に移動します。 複数の組織がある場合は、対象の組織を選択します。

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

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