はじめよう

API トークンの管理

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

概要

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

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

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

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

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

パーソナル API トークンを削除するには、[Remove (削除する)] 列の [X] をクリックします。

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

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

プロジェクト API トークンを削除するには、[[Remove (削除する)] 列の [X] をクリックします。 確認ウィンドウが表示されたら、[Remove (削除する)] ボタンをクリックします。

次のステップ

API トークンは何らかの作業に活用されて初めて、その効力を発揮します。 たとえば以下のような用途が考えられます。