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

Who can do this?
Role: Organization admin
Atlassian Cloud: All plans
Atlassian Government Cloud: Available

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.

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

API キーの作成時にその 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.

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

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

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

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

  1. 移動 Atlassian Administration. Select your organization if you have more than one.

  2. Select Organization settings > API keys.

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

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

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

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

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

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

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

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

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

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. 移動 Atlassian Administration. Select your organization if you have more than one.

  2. Select Organization settings > API keys.

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

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

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

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

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

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

API キーを取り消す

API キーを取り消すには:

  1. 移動 Atlassian Administration. Select your organization if you have more than one.

  2. Select Organization settings > API keys.

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

API キーの取り消しは永続的な操作です。取り消したキーが機能しなくなるには、最大 10 分かかる場合があります。

 

さらにヘルプが必要ですか?

アトラシアン コミュニティをご利用ください。