API トークンの権限

API トークンは、権限 (またはスコープ) を制限して作成できる単一目的のユーザーベース トークンです。API トークンには、次のタイプの権限を使用できます。

• リポジトリ

• プル リクエスト

• プロジェクト

• ワークスペース

• ユーザー データ

• Pipelines

• ランナー

• 課題

• Webhook

• スニペット

• SSH キー

• GPG キー

• 権限

リポジトリ

リポジトリ権限は、ユーザーの Bitbucket Cloud リポジトリを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のリポジトリ権限レベルが許可されます。

• 読み取り

• 書き込み

• 管理

• 削除

読み取り

read:repository:bitbucket API スコープと同等です。

リポジトリ データの表示を許可します。このスコープはリポジトリのプル リクエストへのアクセス権を与えるわけではないことにご注意ください。

• リポジトリのソース コードへのアクセス

• API を使用したファイルへのアクセス

• ブランチ モデル、既定のレビュワーなどの特定のリポジトリ構成へのアクセス。

書き込み

write:repository:bitbucket API スコープと同等です。

ソース コードを含む、ユーザーが変更するためのアクセス権を持つすべてのリポジトリを変更するためのアクセス権を提供します。これにはプル リクエストは含まれません。公開リポジトリと非公開リポジトリの区別は行われません。このスコープは read:repository:bitbucket スコープを意味するものではないため、必要に応じて別途リクエストする必要があります。

管理

admin:repository:bitbucket API スコープと同等です。

リポジトリに対する管理アクティビティを許可します。公開リポジトリと非公開リポジトリの区別は行われません。このスコープは、read:repository:bitbucket スコープや write:repository:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。1 つのリポジトリの管理機能へのアクセス権のみを付与し、コンテンツへの直接アクセス権は付与しません。このスコープには次の機能へのアクセス権が含まれています。

• リポジトリを作成する

• リポジトリ権限の表示

• ブランチ制限の表示および編集

• ブランチ モデル設定の編集

• 既定のレビュアーを編集する

• リポジトリ設定の継承状態の表示と編集

削除

delete:repository:bitbucket API スコープと同等です。

リポジトリ データの削除を許可します。

プル リクエスト

プル リクエスト権限は、ユーザーがアクセス可能な Bitbucket Cloud プル リクエストを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のプル リクエスト権限レベルが許可されます。

• 読み取り

• 書き込み

読み取り

read:pullrequest:bitbucket API スコープと同等です。

プル リクエストの表示と、プル リクエストへのコメント機能を許可します。

このスコープは、read:repository:bitbucket スコープを意味するものではありません。このスコープでは、プル リクエスト エンドポイントを使用してプル リクエストのソース/宛先リポジトリに固有のデータを取得できますが、リポジトリ API エンドポイントへのアクセスは許可されません。

書き込み

write:pullrequest:bitbucket API スコープと同等です。

プル リクエストを作成、アップデート、承認、拒否、マージする権限を許可します。このスコープは、write:repository:bitbucket スコープを意味するものではありません。

プロジェクト

プロジェクト権限は、ユーザーの Bitbucket Cloud プロジェクトを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のプロジェクト権限レベルが許可されます。

• 読み取り

• 管理

読み取り

read:project:bitbucket API スコープと同等です。

プロジェクトとプロジェクト権限データの閲覧を許可します。

管理

admin:project:bitbucket API スコープと同等です。

プロジェクトを作成、アップデート、削除する権限を許可します。公開プロジェクトと非公開プロジェクトは区別されません。このスコープは、read:project:bitbucket スコープや任意のリポジトリ スコープへのアクセスを暗黙的に許可するものではありません。1 つのプロジェクトの管理機能へのアクセス権のみを付与し、リポジトリのコンテンツへの直接アクセス権は付与しません。

ワークスペース

ワークスペース権限は、ユーザーの Bitbucket Cloud プロジェクトを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のワークスペース権限レベルが許可されます。

読み取り

read:workspace:bitbucket API スコープと同等です。

ワークスペースとワークスペース権限データの閲覧を許可します。

管理

admin:workspace:bitbucket API スコープと同等です。

ワークスペースの作成、アップデート、削除を許可します。このスコープは、read:workspace:bitbucket スコープや任意のリポジトリ スコープへのアクセスを暗黙的に許可するものではありません。1 つのワークスペースの管理機能へのアクセス権のみを付与し、ワークスペースのコンテンツへの直接アクセス権は付与しません。

ユーザー

ユーザー権限により、現在のユーザーのデータを表示または変更するアクセス権が付与されます。現在のユーザーとは、API リクエストを行っているユーザーを指します。Bitbucket Cloud では、次のユーザー権限レベルが許可されます。

• 読み取り

• 書き込み

読み取り

read:user:bitbucket API スコープと同等です。

現在のユーザーに関連するデータの閲覧を許可します。

書き込み

write:user:bitbucket API スコープと同等です。

現在のユーザーに関連するデータをアップデートすることを許可します。このスコープは、read:user:bitbucket スコープを意味するものではありません。 

Pipelines

パイプライン権限は、ユーザーがアクセス可能なリポジトリの Bitbucket Pipelines を表示または制御するためのアクセス権を提供します。Bitbucket Cloud では、次のパイプライン権限レベルが許可されます。

• 読み取り

• 書き込み

• 管理

読み取り

read:pipeline:bitbucket API スコープと同等です。

すべてのパイプライン情報 (パイプライン、ステップ、キャッシュ、アーティファクト、ログ、テスト、コード インサイト) への読み取りアクセスを許可します。

書き込み

write:pipeline:bitbucket API スコープと同等です。

パイプラインの実行 (パイプラインの開始/停止/作成) とテスト/コード インサイトのアップロードを許可します。このスコープは、read:pipeline:bitbucket スコープを意味するものではありません。

管理

admin:pipeline:bitbucket API スコープと同等です。

パイプライン変数の作成などの管理者アクティビティを許可します。このスコープは、read:pipeline:bitbucket スコープや write:pipeline:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

ランナー

ランナー権限は、ワークスペースとリポジトリの Bitbucket Pipelines ランナーを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のパイプライン ランナー権限レベルが許可されます。

• 読み取り

• 書き込み

読み取り

read:runner:bitbucket API スコープと同等です。

Bitbucket Pipelines ランナー情報の表示を許可します。

書き込み

write:runner:bitbucket API スコープと同等です。

Bitbucket Pipelines のランナー管理を許可します。このスコープは、read:runners:bitbucket スコープを意味するものではありません。

課題

課題権限は、ユーザーがアクセス可能な Bitbucket Cloud リポジトリ課題を表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次の課題権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

読み取り

read:issue:bitbucket API スコープと同等です。

Bitbucket Cloud リポジトリの課題の閲覧を許可します。

書き込み

write:issue:bitbucket API スコープと同等です。

Bitbucket Cloud リポジトリ課題の作成とアップデートを許可します。このスコープは、read:issue:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

delete:issue:bitbucket API スコープと同等です。

Bitbucket Cloud リポジトリの課題の削除を許可します。

Webhook

Webhook 権限は、ユーザーがアクセス可能なすべての既存の Webhook を表示するためのアクセス権と、他の権限と組み合わせた場合に Webhook を作成するための書き込みアクセス権を提供します。詳細については、「Bitbucket Cloud REST API — Webhook」を参照してください。

• 読み取り

• 書き込み

• 削除

読み取り

read:webhook:bitbucket API スコープと同等です。

Webhook 情報への読み取りアクセスを許可します。

書き込み

write:webhook:bitbucket API スコープと同等です。

ウェブフックの作成とアップデートを許可します。このスコープは、read:webhook:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

delete:webhook:bitbucket API スコープと同等です。

ウェブフックの削除を許可します。

スニペット

スニペット権限は、ユーザーがアクセス可能なワークスペースの Bitbucket Cloud コード スニペットを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次のスニペット権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

読み取り

read:snippet:bitbucket API スコープと同等です。

スニペットの表示を許可します。

書き込み

write:snippet:bitbucket API スコープと同等です。

スニペットの作成とアップデートを許可します。このスコープは、read:snippet:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

delete:snippet:bitbucket API スコープと同等です。

スニペットの削除を許可します。

Wiki

Wiki 権限は、ユーザーがアクセスできるリポジトリ内の Bitbucket Cloud Wiki を表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次の wiki 権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

SSH キー

SSH キー権限により、Bitbucket Cloud SSH キーを表示または変更したり、ユーザーがアクセスできるキーをデプロイしたりできるようになります。Bitbucket Cloud では、次の SSH キー権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

読み取り

read:ssh-key:bitbucket API スコープと同等です。

デプロイ キーと SSH キーに関連する情報への読み取りアクセスを許可します。

書き込み

write:ssh-key:bitbucket API スコープと同等です。

デプロイ キーと SSH キーの作成と更新を許可します。このスコープは、read:ssh-key:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

delete:ssh-key:bitbucket API スコープと同等です。

デプロイ キーと SSH キーの削除を許可します。 

GPG キー

GPG キー権限は、ユーザーがアクセスできる Bitbucket Cloud GPG キーを表示または変更するアクセス権を付与します。Bitbucket Cloud では、次の GPG キー権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

読み取り

read:gpg-key:bitbucket API スコープと同等です。

GPG キーに関連する情報への読み取りアクセスを許可します。

書き込み

write:gpg-key:bitbucket API スコープと同等です。

GPG キーの作成とアップデートを許可します。このスコープは、read:gpg-key:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

delete:gpg-key:bitbucket API スコープと同等です。

GPG キーの削除を許可します。

権限

権限は、ユーザーがアクセスできる Bitbucket Cloud 権限データを表示または変更するためのアクセス権を提供します。Bitbucket Cloud では、次の権限レベルが許可されます。

• 読み取り

• 書き込み

• 削除

読み取り

read:permission:bitbucket API スコープと同等です。

権限データへの読み取りアクセスを許可します。

書き込み

write:permission:bitbucket API スコープと同等です。

権限関連のデータを作成および変更する機能を許可します。このスコープは、read:permission:bitbucket スコープへのアクセスを暗黙的に許可するものではありません。

削除

権限関連データの削除を許可します。