API token permissions

API tokens are single-purpose, user-based tokens which can be created with limited permissions (or scopes). The following types of permissions are available for API tokens:

• リポジトリ

• プル リクエスト

• プロジェクト

• ワークスペース

• User data

• Pipelines

• ランナー

• 課題

• Webhook

• スニペット

• SSH キー

• GPG keys

• 権限

リポジトリ

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

• 読み取り

• 書き込み

• 管理

• 削除

読み取り

Equivalent to read:repository:bitbucket API scope

Allows viewing of repository data. Note that this scope does not give access to a repository's pull requests.

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

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

• access to certain repository configurations such as branching model, default reviewers, etc.

書き込み

Equivalent to write:repository:bitbucket API scope

Provides access to modify all the repositories the user has access to change, including the source code. This does not include pull requests. No distinction is made between public and private repositories. This scope does not imply the read:repository:bitbucket scope, so you need to request that separately, if required.

管理

Equivalent to admin:repository:bitbucket API scope

Allows admin activities on repositories. No distinction is made between public and private repositories. This scope does not implicitly grant access to the read:repository:bitbucket or the write:repository:bitbucket scopes. It gives access to the admin features of a repository only, not direct access to its contents. This scope comes with access to the following functionality:

• リポジトリを作成する

• view repository permissions

• view and edit branch restrictions

• edit branching model settings

• edit default reviewers

• view and edit inheritance state for repository settings

削除

Equivalent to delete:repository:bitbucket API scope

Allows the deletion of repositories data.

プル リクエスト

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

• 読み取り

• 書き込み

読み取り

Equivalent to read:pullrequest:bitbucket API scope

Allows viewing of pull requests, plus the ability to comment on pull requests.

This scope does not imply the read:repository:bitbucket scope. With this scope, you could retrieve some data specific to the source/destination repositories of a pull request using pull request endpoints, but it does not give access to repository API endpoints.

書き込み

Equivalent to write:pullrequest:bitbucket API scope

Allows the ability to create, update, approve, decline, and merge pull requests. This scope does not imply the write:repository:bitbucket scope.

プロジェクト

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

• 読み取り

• 管理

読み取り

Equivalent to read:project:bitbucket API scope

Allows viewing of project and project permission data.

管理

Equivalent to admin:project:bitbucket API scope

Allows the ability to create, update, and delete a project. No distinction is made between public and private projects. This scope does not implicitly grant access to the read:project:bitbucket scope or any repository scopes. It gives access to the admin features of a project only, not direct access to its repositories' contents.

ワークスペース

Workspace permissions provide access to view or modify the user’s Bitbucket Cloud Projects. Bitbucket Cloud allows the following workspace permission levels:

読み取り

Equivalent to read:workspace:bitbucket API scope

Allows viewing of workspace and workspace permission data.

管理

Equivalent to admin:workspace:bitbucket API scope

Allows the ability to create, update and delete the workspace. This scope does not implicitly grant access to the read:workspace:bitbucket scope or any repository scopes. It gives access to the admin features of a workspace only, not direct access to its workspaces' contents.

ユーザー

User permissions provide access to view or modify the current user’s data. The current user refers to the user making the API request. Bitbucket Cloud allows the following user permission levels:

• 読み取り

• 書き込み

読み取り

Equivalent to read:user:bitbucket API scope

Allows viewing of data related to the current user.

書き込み

Equivalent to write:user:bitbucket API scope

Allows the ability to update data related to the current user. This scope does not imply the read:user:bitbucket scope. 

Pipelines

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

• 読み取り

• 書き込み

• 管理

読み取り

Equivalent to read:pipeline:bitbucket API scope

Allows read access to all pipeline information (pipelines, steps, caches, artifacts, logs, tests, and code-insights).

書き込み

Equivalent to write:pipeline:bitbucket API scope

Allows running pipelines (i.e., start/stop/create pipeline) and uploading tests/code-insights. This scope does not imply the read:pipeline:bitbucket scope.

管理

Equivalent to admin:pipeline:bitbucket API scope

Allows admin activities, such as creating pipeline variables. This scope does not implicitly grant access to the read:pipeline:bitbucket or the write:pipeline:bitbucket scopes.

ランナー

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

• 読み取り

• 書き込み

読み取り

Equivalent to read:runner:bitbucket API scope

Allows viewing of Bitbucket Pipelines runners information.

書き込み

Equivalent to write:runner:bitbucket API scope

Allows Bitbucket Pipelines runners management. This scope does not imply the read:runners:bitbucket scope.

課題

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

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:issue:bitbucket API scope

Allows the viewing of Bitbucket Cloud repository issues.

書き込み

Equivalent to write:issue:bitbucket API scope

Allows the ability to create and update Bitbucket Cloud repository issues. This scope does not implicitly grant access to the read:issue:bitbucket scope.

削除

Equivalent to delete:issue:bitbucket API scope

Allows the deletion of Bitbucket Cloud repository issues.

Webhook

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

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:webhook:bitbucket API scope

Allows read access to webhooks information.

書き込み

Equivalent to write:webhook:bitbucket API scope

Allows the ability to create and update webhooks. This scope does not implicitly grant access to the read:webhook:bitbucket scope.

削除

Equivalent to delete:webhook:bitbucket API scope

Allows the deletion of webhooks.

スニペット

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

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:snippet:bitbucket API scope

Allows the viewing of snippets.

書き込み

Equivalent to write:snippet:bitbucket API scope

Allows the ability to create and update snippets. This scope does not implicitly grant access to the read:snippet:bitbucket scope.

削除

Equivalent to delete:snippet:bitbucket API scope

Allows the deletion of snippets.

SSH キー

SSH key permissions provide access to view or modify Bitbucket Cloud SSH keys and deploy keys that are accessible by the user. Bitbucket Cloud allows the following SSH key permission levels:

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:ssh-key:bitbucket API scope

Allows read access to information related to deploy keys and SSH keys.

書き込み

Equivalent to write:ssh-key:bitbucket API scope

Allows the ability to create and update deploy keys and SSH keys. This scope does not implicitly grant access to the read:ssh-key:bitbucket scope.

削除

Equivalent to delete:ssh-key:bitbucket API scope

Allows the deletion of deploy keys and SSH keys. 

GPG keys

GPG key permissions provide access to view or modify Bitbucket Cloud GPG keys that are accessible by the user. Bitbucket Cloud allows the following GPG key permission levels:

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:gpg-key:bitbucket API scope

Allows read access to information related to GPG keys.

書き込み

Equivalent to write:gpg-key:bitbucket API scope

Allows the ability to create and update GPG keys. This scope does not implicitly grant access to the read:gpg-key:bitbucket scope.

削除

Equivalent to delete:gpg-key:bitbucket API scope

Allows the deletion of GPG keys.

権限

Permissions provide access to view or modify Bitbucket Cloud permission data that are accessible by the user. Bitbucket Cloud allows the following permission levels:

• 読み取り

• 書き込み

• 削除

読み取り

Equivalent to read:permission:bitbucket API scope

Allows read access to permissions data.

書き込み

Equivalent to write:permission:bitbucket API scope

Allows the ability to create and modify permissions related data. This scope does not implicitly grant access to the read:permission:bitbucket scope.

削除

Allows the deletion of permissions related data.