API トークンの管理

CircleCI の API を使用したり、ビルドの詳細を確認したりするには、適切な権限を持つ API トークンが必要です。 ここでは、API トークンの種類と、トークンを作成および削除する方法について説明します。


CircleCI では 2 種類の API トークンを作成できます。

There are two types of API tokens you can create within CircleCI.

  1. パーソナル: このトークンは CircleCI API とのやり取りに使用され、完全な読み取りアクセス権と書き込みアクセス権を付与します。
  2. プロジェクト: このトークンは、特定のプロジェクトに関する情報を提供し、読み取りアクセス権のみを付与します。 プロジェクト トークンには、StatusBuild ArtifactsAll の 3 つのスコープ オプションがあります。 - Status トークン: プロジェクトのビルド ステータスへの読み取りアクセス権を付与します。 ステータス バッジを埋め込む際に便利です。 - All トークン: プロジェクトのビルド ステータスおよびビルド アーティファクトへの読み取りアクセス権を付与します。 - Build Artifacts トークン: プロジェクトのビルド アーティファクトへの読み取りアクセス権を付与します。

メモ: API トークンは、一度作成すると修正できません。 既存のトークンを変更するには、いったん削除してから再作成する必要があります。

パーソナル API トークンの作成

  1. CircleCI アプリケーションで、ユーザー設定に移動します。
  2. [Personal API Tokens (パーソナル API トークン)]{:rel=”nofollow”} をクリックします。
  3. [Create New Token (新しいトークンを作成する)] ボタンをクリックします。
  4. [Token name (トークン名)] フィールドに、覚えやすいトークン名を入力します。
  5. [Add API Token (API トークンを追加する)] ボタンをクリックします。
  6. トークンが表示されたら、別の場所にコピー & ペーストします。 トークンを再度表示することはできません。

To delete a personal API token, click the X in the Remove column and confirm your deletion in the dialog window.

プロジェクト API トークンの作成

  1. CircleCI アプリケーションで、プロジェクトの横にある歯車のアイコンをクリックして、プロジェクトの設定に移動します。
  2. [Permissions (権限)] セクションで、[API Permissions (API の権限)] をクリックします。
  3. [Create Token (トークンを作成する)] ボタンをクリックします。
  4. ドロップダウン メニューからスコープを選択します。
  5. [Token Label (トークン ラベル)] フィールドに、覚えやすいラベルを入力します。
  6. [Add Token (トークンを追加する)] ボタンをクリックします。

To delete a project API token, Click the X in the Remove column for the token you wish to replace. When the confirmation window appears, enter the text DELETE in the form and click the Delete API Token button.

Rotating Personal and Project API Tokens

API Token rotation occurs when an old API token is replaced with a new token.

Because API Tokens can be shared, passed around between employees and teams, and exposed inadvertently, it is always good practice to periodically regenerate new API Tokens. Many organizations automate this process, running a script when an employee leaves the company or when a token has been considered leaked.

Rotating a Personal API Token

  1. In the CircleCI application, go to your User settings.
  2. Click Personal API Tokens.
  3. パーソナル API トークンを削除するには、[Remove (削除する)] 列の [X] をクリックします。
  4. Click the Create New Token button.
  5. In the Token name field, type a new name for the old token you are rotating. It can be the same name given to the old token.
  6. Click the Add API Token button.
  7. After the token appears, copy and paste it to another location. You will not be able to view the token again.

Rotating a Project API Token

  1. In the CircleCI application, go to your project’s settings by clicking the gear icon next to your project.
  2. In the Permissions section, click on API Permissions.
  3. プロジェクト API トークンを削除するには、[[Remove (削除する)] 列の [X] をクリックします。 確認ウィンドウが表示されたら、[Remove (削除する)] ボタンをクリックします。
  4. Click the Create Token button.
  5. Choose the same scope used for the old token from the dropdown menu.
  6. In the Token Label field, type a label for the token. It can be the same name given to the old token.
  7. Click the Add Token button.


Some possible usecases for an API token might be:

Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.