ドキュメント
circleci.com
Start Building for Free

API トークンの管理

1 month ago1 min read
Cloud
Server v3.x
Server v2.x
On This Page

CircleCI の API を使用したり、パイプラインの詳細を確認したりするには、適切なアクセス許可を持つ API トークンが必要です。 ここでは、利用可能な API トークンの種類と、トークンを作成および削除する方法について説明します。

概要

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

  1. パーソナル: このトークンは CircleCI API とのやり取りに使用され、すべての情報の読み取りと書き込みに対するアクセス権を付与します。
  2. プロジェクト: このトークンは特定のプロジェクトに関する情報の読み取りと書き取りに対するアクセス権を付与します。 プロジェクト トークンには、ステータス読み取り専用すべて、の 3 つの権限範囲のオプションがあります。 - ステータス トークン: プロジェクトのビルド ステータスの読み取りに対するアクセス権を付与します。 ステータス バッジを埋め込む際に便利です。 - 読み取り専用 トークンは、プロジェクトの API への読み取り専用のアクセス権を付与します。 - 管理者 トークンは、プロジェクトの API の読み取りおよび書き込みに対するアクセス権を付与します。

注意: 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 アプリケーションで、プロジェクトの設定に移動します。 移動にはいくつかの方法があります。 1 つの方法として、サイドバーから Projects (プロジェクト) を選択し、 プロジェクトの横の省略記号(...)を選択し、Project Settings (プロジェクト設定) を選択します。
  2. API Permissions (API のアクセス権)を選択します。
  3. [Add API Token (API トークンを追加する)] ボタンをクリックします。
  4. ドロップダウン メニューから権限の範囲を選択します。 権限については、ページ上部の 概要セクションで説明しています。
  5. Label (ラベル)フィールドに、覚えやすいラベルを入力します。
  6. [Add API Token (API トークンを追加する)] ボタンをクリックします。

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

パーソナル トークンとプロジェクト API トークンのローテーション

API トークンのローテーションとは、古い API トークンを新しいトークンに置き換えることです。

API トークンは共有されたり、従業員やチームの間で回されたり、 不用意に公開されたりする可能性があるため、定期的に新しい APIトークンを再生成することをお勧めします。 多くの組織では、このプロセスを自動化しており、 の従業員が退職したときや、トークンが漏洩したと思われるときにスクリプトを実行しています。

パーソナル API トークンのローテーション

  1. CircleCI アプリケーションで、 ユーザー設定に移動します。
  2. パーソナル API トークンをクリックします。
  3. パーソナル API トークンを削除するには、[Remove (削除する)] 列の [X] をクリックします。
  4. [Create New Token (新しいトークンを作成する)] ボタンをクリックします。
  5. Token name (トークン名) フィールドに、ローテーションする古いトークンの新しい名前を入力します。 古いトークンと同じ名前でもかまいません。
  6. [Add API Token (API トークンを追加する)] ボタンをクリックします。
  7. トークンが表示されたら、別の場所にコピー & ペーストします。 トークンを再度表示することはできません。

プロジェクト API トークンのローテーション

  1. CircleCI アプリケーションで、プロジェクトの設定に移動します。 移動にはいくつかの方法があります。 1 つの方法として、サイドバーから Projects (プロジェクト) を選択し、 プロジェクトの横の省略記号(...)を選択し、Project Settings (プロジェクト設定) を選択します。
  2. API Permissions (API のアクセス権)を選択します。
  3. 入れ替えたいトークンの[[Remove (削除する)] 列の X をクリックします。 確認ウィンドウが表示されたら、フォームに DELETE と入力し、 Delete API Token (API トークンを削除する) ボタンをクリックします。
  4. Create API Token (API トークンを作成する) ボタンをクリックします。
  5. 古いトークンに使用したのと同じ範囲を、ドロップダウンメニューから選択します。
  6. Label (ラベル)フィールドに、トークンのラベルを入力します。 古いトークンと同じ名前でもかまいません。
  7. [Add API Token (API トークンを追加する)] ボタンをクリックします。

次のステップ

APIトークンの使用例としては、以下のようなものが考えられます。


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。