正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

アクセストークンスコープ

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

スコープは、アクセストークンが特定の組織レベルで実行できる内容を定義します。各スコープは、特定の権限セットを付与します。

トークンタイプは、トークンの到達範囲を決定します:

  • あるパーソナルアクセストークンは、ユーザーが利用できるすべてのグループとプロジェクトにアクセスできます。
  • あるグループアクセストークンは、そのグループ内のサブグループとプロジェクトにアクセスできます。
  • あるプロジェクトアクセストークンは、そのプロジェクトにのみアクセスできます。

パーソナルアクセストークンを特定のリソースと権限に制限するには、詳細権限パーソナルアクセストークンを参照してください。

スコープトークンの可用性説明
api個人、グループ、プロジェクトアクセストークンのスコープのAPIに対する読み取りおよび書き込みの完全なアクセス権を付与します。コンテナレジストリ、依存プロキシ、およびパッケージレジストリが含まれます。1
read_api個人、グループ、プロジェクトトークンのスコープのAPIに対する読み取りアクセス権を付与します。パーソナルアクセストークンの場合、コンテナレジストリとパッケージレジストリが含まれます。グループアクセストークンとプロジェクトアクセストークンの場合、パッケージレジストリのみです。
read_repository個人、グループ、プロジェクトトークンのスコープのリポジトリへの読み取りアクセス（プル）を付与します。パーソナルアクセストークンの場合はプライベートプロジェクト、グループアクセストークンの場合はグループ内のすべてのリポジトリ、プロジェクトアクセストークンの場合はプロジェクト内のリポジトリです。Git-over-HTTPまたはリポジトリファイルAPIを使用します。
write_repository個人、グループ、プロジェクトトークンのスコープのリポジトリへの読み取りおよび書き込みアクセス（プルおよびプッシュ）を付与します。パーソナルアクセストークンの場合はプライベートプロジェクト、グループアクセストークンの場合はグループ内のすべてのリポジトリ、プロジェクトアクセストークンの場合はプロジェクト内のリポジトリです。Git-over-HTTPを使用します。API認証はサポートされていません。
read_registry個人、グループ、プロジェクト認可が必要な場合、コンテナレジストリイメージへの読み取りアクセス（プル）を付与します。コンテナレジストリが有効になっている場合にのみ使用できます。プライバシー条件はトークンタイプによって異なります。パーソナルアクセストークンの場合、プロジェクトがプライベートであるときに適用されます。グループアクセストークンの場合、グループ内のいずれかのプロジェクトがプライベートであるときに適用されます。プロジェクトアクセストークンの場合、プロジェクトがプライベートであるときに適用されます。
write_registry個人、グループ、プロジェクトコンテナレジストリイメージへの書き込みアクセス（プッシュ）を付与します。コンテナレジストリが有効になっている場合にのみ使用できます。グループアクセストークンおよびプロジェクトアクセストークンの場合、画像をプッシュするにはread_registryスコープも含まれている必要があります。
self_rotate個人、グループ、プロジェクトこのトークンをローテーションする権限を付与します。他のトークンはローテーションできません。パーソナルアクセストークンをローテーションするには、パーソナルアクセストークンAPIを参照してください。
read_virtual_registry個人、グループ依存プロキシを介してコンテナイメージへの読み取りアクセス（プル）を付与します。依存プロキシが有効になっている場合にのみ使用できます。2
write_virtual_registry個人、グループ依存プロキシを介してコンテナイメージへの読み取りおよび書き込みアクセス（プル、プッシュ、および削除）を付与します。依存プロキシが有効になっている場合にのみ使用できます。2
create_runner個人、グループ、プロジェクトトークンのスコープのRunnerを作成する権限を付与します。
manage_runner個人、グループ、プロジェクトトークンのスコープのRunnerを管理する権限を付与します。
ai_features個人、グループ、プロジェクトGitLab Duo、コード提案API、およびGitLab Duo Chat APIのAPIアクションを実行する権限を付与します。JetBrains向けGitLab Duoプラグインと連携するように設計されています。その他のすべての拡張機能については、各拡張機能のドキュメントを参照してください。GitLab Self-Managedバージョン16.5、16.6、および16.7では動作しません。GitLab Self-ManagedおよびGitLab Dedicatedでは、このスコープはGitLab Duoが有効な場合にのみ利用できます。
k8s_proxy個人、グループ、プロジェクトKubernetes向けのエージェントを介してKubernetes APIコールを実行する権限を付与します。
admin_mode個人管理者モードが有効になっている場合にAPIアクションを実行する権限を付与します。GitLab Self-Managedインスタンスの管理者のみが使用できます。
read_service_ping個人管理者として認証されたときに、APIを介してService Pingペイロードをダウンロードするアクセス権を付与します。
sudo個人管理者として認証されている場合、システム内の任意のユーザーとしてAPIアクションを実行する権限を許可します。
read_user個人/user APIエンドポイントを介して、認証済みユーザーのプロファイルへの読み取り専用アクセスを許可します。これには、ユーザー名、公開メール、および氏名が含まれます。また、/usersの下にある読み取り専用APIエンドポイントへのアクセスも許可します。

外部認可をオンにしている場合、パーソナルアクセストークンとプロジェクトアクセストークンはコンテナまたはパッケージレジストリにアクセスできません。アクセスを復元するには、外部認可をオフにしてください。

補足説明:

  1. パーソナルアクセストークンの場合、apiはGit-over-HTTPを介したレジストリとリポジトリへの完全な読み取りおよび書き込みアクセスも付与します。グループアクセストークンおよびプロジェクトアクセストークンには、このGit-over-HTTP句は含まれません。
  2. パーソナルアクセストークンの場合、仮想レジストリのスコープは、プロジェクトがプライベートであり、認可が必要な場合にのみ適用されます。グループアクセストークンにはそのような条件はありません。