group-privileges エンドポイント

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API バージョン 1 は 2018 年 6 月 30 日に廃止予定となり、2019 年 4 月 29 日に REST API から完全に削除されました。廃止についての告知をご確認ください。また、バージョン 2.0 の REST API ドキュメントをご確認ください。

限られた 1.0 API リソースの一時的なサポートについて

2.0 REST API では、ユーザーおよびグループ管理は Atlassian Cloud Admin API を使用して行う予定ですが、これらの API エンドポイントはまだ提供されていません。Bitbucket でアトラシアンのプラットフォームサービスが完全に利用できるようになるまでは、次の 1.0 REST エンドポイントが引き続きサポートされます。

/1.0/groups
/1.0/group-privileges
/1.0/invitations
/1.0/users/{accountname}/invitations

概要

group-privileges リソースを使用して、Bitbucket Cloud のアカウントのリポジトリのグループ権限を確認および操作します。アカウントオーナー (またはチームアカウント管理者) はグループをアカウントレベルで定義します。group-privileges リソースの構造は次のとおりです。

{
   "repo":"1team/justdirectteam",
   "privilege":"admin",
   "group":{
      "owner":{
         "display_name":"1team",
         "uuid":"{c423e13e-b541-3e77-b363-3e0b458u8226}",
         "is_team":true,
         "mention_id":null,
         "avatar":"https://secure.gravatar.com/avatar/12e5043.png",
         "nickname":"1team",
         "account_id":null
      },
      "name":"Administrators",
      "members":[
         {
            "display_name":"Justen Stepka",
            "uuid":"{c423e13e-b541-3e77-b363-3e0b458u8226}",
            "is_team":false,
            "avatar":"https://secure.gravatar.com/avatar/12e5043",
            "nickname":"jstepka",
            "account_id":"557057:016ad873-3455-3455-23443-233534545434"
         }
      ],
      "slug":"administrators"
   },
   "repository":{
      "owner":{
         "display_name":"Justen Stepka",
         "uuid":"{b8441b1d-a5e6-480a-ba0b-fde829182e4a}",
         "is_team":true,
         "mention_id":null,
         "avatar":"https://secure.gravatar.com/avatar/12e5043",
         "nickname":"supertesterteam",
         "account_id":null
      },
      "name":"justdirectteam",
      "slug":"justdirectteam"
   }
}

上記の例では、グループ Administrators は justdirectteam リポジトリへのアクセス権を持ちます。Administrators グループには、1 人のメンバー (Jstepka) がいます。以下のテーブルでは、group-privileges リソース内の各フィールドを説明しています。

フィールド	説明
repo	リポジトリのオーナーとリポジトリ名の "owner/repository" 形式。
privilege	グループに関連付けられた権限。
group	グループに関連付けられたプロファイル。
	owner	オーナーのアカウントプロファイル。
		display_name	ユーザーが提供する、アカウントに関連付けられた名前。
		uuid	アカウントの一意の識別子。
		nickname	display_name が公開されていない場合の公開名。
		account_id	Atlassian アカウント ID。
	members		ユーザーアカウントプロファイルの配列。各プロファイルは単一のグループメンバーを表します。
	slug		グループの識別子。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。 viewer-release-management
repository	グループがアクセス権を持つリポジトリ。
	owner		所有グループのアカウントプロファイル。
	name		表示されるリポジトリ名。
	slug		リポジトリ ID。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。リポジトリに "My Cool Code" という名前をつけると、スラッグは以下のようになります。 my-cool-code

フィルターで結果を制限する

このリソースで GET メソッドを使用する際、filter=read|write|admin クエリパラメータを使用して、結果を特定の権限レベルに制限することができます。

$ curl --request GET --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/?filter=admin

private=true クエリパラメーターを使用して、非公開リポジトリで絞り込むことができます。

$ curl --request GET --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/?private=true

権限を持つグループの一覧の GET

GET https://api.bitbucket.org/1.0/group-privileges/{workspace_id}

特定のアカウントのリポジトリへのアクセス権が付与されているすべてのグループの配列を取得します。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター	必須かどうか	説明
workspace_id	はい	ワークスペース ID。

リポジトリの権限を持つグループの一覧の GET

GET https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/{repo_slug}

特定のリポジトリで権限を持つグループの一覧を取得します。呼び出し元は正常に認証され、アカウントの管理権限を所有している必要があります。このメソッドには次のパラメータがあります。

パラメーター	必須かどうか	説明
workspace_id	はい	ワークスペース ID。
repo_slug	はい	そのアカウントに所属しているリポジトリ。

リポジトリのグループの GET

GET https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/{repo_slug}/{group_owner}/{group_slug}

リポジトリのグループの権限を取得します。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター	必須かどうか	説明
workspace_id	はい	ワークスペース ID。
repo_slug	はい	そのアカウントに所属しているリポジトリ。
group_owner	はい	グループを所有するアカウント。
group_slug	はい	グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。 viewer-release-management

特定の権限グループを持つリポジトリの一覧の GET

GET https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/{group_owner}/{group_slug}

特定の権限グループが表示されるリポジトリの一覧を取得します。このメソッドでは単一のアカウントで動作し、複数のアカウントに横断することはありません。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター

必須かどうか

説明

workspace_id

はい

ワークスペース ID。

group_owner

はい

グループを所有するアカウント。

group_slug

はい

グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。

viewer-release-management

例

たとえば次の呼び出しでは、mcatalbas が所有する各リポジトリでグループ mcatalbas/designers が何らかのレベルのアクセス権を持つものを確認し、そのリポジトリでのグループの権限を一覧化します。

https://api.bitbucket.org/1.0/group-privileges/api/1.0/group-privileges/mcatalbas/mcatalbas/designers

リポジトリへのグループ権限の PUT

PUT https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/{repo_slug}/{group_owner}/{group_slug} --data "{privilege}"

PUT メソッドを使用して、リポジトリにグループ権限を付与します。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター	必須かどうか	説明
workspace_id	はい	ワークスペース ID。
repo_slug	はい	権限を付与するリポジトリ。
group_owner	はい	グループを所有するアカウント。
group_slug	はい	グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。 viewer-release-management
privilege	はい	権限の値。次の値が許可されます。 read write admin

例

たとえば次の呼び出しでは、mcatalbas/sys-admins グループを読み取り権限で test リポジトリに追加します。

$ curl --request PUT --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/test/mcatalbas/sys-admins --data read

リポジトリからのグループ権限の DELETE

DELETE https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/{repo_slug}/{group_owner}/{group_slug} 

リポジトリから権限グループを削除します。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター	必須かどうか	説明
workspace_id	はい	ワークスペース ID。
repo_slug	はい	権限を付与するリポジトリ。
group_owner	はい	グループを所有するアカウント。
group_slug	はい	グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。 viewer-release-management

例

たとえば次の呼び出しでは、test リポジトリからグループ mcatalbas/developers の権限を取り消します。

$ curl --request DELETE --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/test/mcatalbas/developers

この呼び出しでは、正常に完了すると HTTP/1.1 204 NO CONTENT が返されます。

すべてのリポジトリでのグループ権限の DELETE

DELETE https://api.bitbucket.org/1.0/group-privileges/{workspace_id}/group_owner}/{group_slug} 

関連するすべてのリポジトリからグループの権限を削除します。呼び出し元はアカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメーター

必須かどうか

説明

workspace_id

はい

ワークスペース ID。

group_owner

はい

グループを所有するアカウント。

group_slug

はい

viewer-release-management

例

たとえば次の呼び出しでは、mtcalbas のすべてのリポジトリからグループ mtcatalbas/developers の権限を取り消します。

$ curl --request DELETE --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/mcatalbas/developers

成功した場合、この呼び出しは 200 ステータスコードと空のレスポンスポディを返します。

この内容はお役に立ちましたか?

正確ではなかった

明確ではなかった

関係なかった

さらにヘルプが必要ですか?

アトラシアンコミュニティをご利用ください。

コミュニティに質問