group-privileges エンドポイント

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

Use the group-privileges resource to query and manipulate the group privileges (permissions) of a Bitbucket Cloudaccount's repositories. An account owner (or team account administrator) defines groups at the account level. A group-privileges resource has the following structure:

{
        "repo": "1team/justdirectteam",
        "privilege": "admin",
        "group": {
            "owner": {
                "username": "1team",
                "first_name": "1 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/24b6be68b53e383c5d42bab4fe0bde2b?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Administrators",
            "members": [
                {
                    "username": "nvenegas",
                    "first_name": "Nicolas",
                    "last_name": "Venegas"
                },
                {
                    "username": "brao",
                    "first_name": "Brodie",
                    "last_name": "Rao"
                }
            ],
            "slug": "administrators"
        },
        "repository": {
            "owner": {
                "username": "1team",
                "first_name": "1 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/24b6be68b53e383c5d42bab4fe0bde2b?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "justdirectteam",
            "slug": "justdirectteam"
        }
}

In the above example, the group Administrators has access to the justdirectteam repository.  The Administrators group has two members – nvenegas and brao.  The table below describes each field in the group-privileges resource:

フィールド 説明
repo The owner and name of the repository name in the form owner/repository.
privilege グループに関連付けられた権限。
group グループに関連付けられたプロファイル。
owner オーナーのアカウント プロファイル。
name 表示されるグループ名。
members ユーザー アカウント プロファイルの配列。各プロファイルは単一のグループ メンバーを表します。
slug

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

viewer-release-management

repository グループがアクセス権を持つリポジトリ。
owner 所有グループのアカウント プロファイル。
name 表示されるリポジトリ名。
slug

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

my-cool-code

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

When using the GET methods on this resource, you can use the filter=read|write|admin query parameter to limit your results to a specific privilege level:

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

You can use the private=true query parameter to filter for private repositories:

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

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

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

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
GET https://api.bitbucket.org/1.0/group-privileges/{accountname}
正常時に返されるデータを表示するにはここをクリック...
$ 
[
    {
        "repo": "mcatalbas/test",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "mcatalbas",
                "first_name": "Mehmet",
                "last_name": "Catalbas"
            },
            "name": "developers",
            "members": [
                {
                    "username": "nvenegas",
                    "first_name": "Nicolas",
                    "last_name": "Venegas"
                },
                {
                    "username": "brao",
                    "first_name": "Brodie",
                    "last_name": "Rao"
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "mcatalbas",
                "first_name": "Mehmet",
                "last_name": "Catalbas"
            },
            "name": "test",
            "slug": "test"
        }
    },
    {
        "repo": "mcatalbas/test",
        "privilege": "admin",
        "group": {
            "owner": {
                "username": "mcatalbas",
                "first_name": "Mehmet",
                "last_name": "Catalbas"
            },
            "name": "managers",
            "members": [
                {
                    "username": "detkin",
                    "first_name": "Dylan",
                    "last_name": "Etkin"
                },
                {
                    "username": "jnoehr",
                    "first_name": "Jesper",
                    "last_name": "Noehr"
                }
            ],
            "slug": "managers"
        },
        "repository": {
            "owner": {
                "username": "mcatalbas",
                "first_name": "Mehmet",
                "last_name": "Catalbas"
            },
            "name": "test",
            "slug": "test"
        }
    }
]


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

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

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
GET https://api.bitbucket.org/1.0/group-privileges/{accountname}/{repo_slug}
正常時に返されるデータを表示するにはここをクリック...
[
    {
        "repo": "2team/grouptest",
        "privilege": "read",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Contractors",
            "members": [],
            "slug": "contractors"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    },
    {
        "repo": "2team/grouptest",
        "privilege": "admin",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Administrators",
            "members": [
                {
                    "username": "2team",
                    "first_name": "2 Team",
                    "last_name": "",
                    "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                    "is_team": true
                },
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "administrators"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    },
    {
        "repo": "2team/grouptest",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    }
]
   

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

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

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

viewer-release-management

GET  https://api.bitbucket.org/1.0/group-privileges/{accountname}/{repo_slug}/{group_owner}/{group_slug}
ここをクリックして展開...
[
    {
        "repo": "2team/grouptest",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    }
]

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

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

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
group_owner はい グループを所有するアカウント。
group_slug はい グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。

viewer-release-management

たとえば、以下のように呼び出します。

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

Locates each repository owned by mcatalbas to which the group mcatalbas/designers has some level of access and lists the group's privileges in that repository.

GET https://api.bitbucket.org/1.0/group-privileges/{accountname}/{group_owner}/{group_slug}
ここをクリックして展開...
[
    {
        "repo": "2team/public2teamrepo",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "public2teamrepo",
            "slug": "public2teamrepo"
        }
    },
    {
        "repo": "2team/createdbyteamacct",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "createdbyteamacct",
            "slug": "createdbyteamacct"
        }
    },
    {
        "repo": "2team/teamproject",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "teamproject",
            "slug": "teamproject"
        }
    },
    {
        "repo": "2team/grouptest",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    }
]

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

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

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

viewer-release-management

privilege はい

権限の値。次の値が許可されます。

  • read
  • write
  • admin

たとえば、以下のように呼び出します。

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

This example adds the  mcatalbas/sys-admins group to the test repository with a privilege of read.

PUT https://api.bitbucket.org/1.0/group-privileges/{accountname}/{repo_slug}/{group_owner}/{group_slug} --data "{privilege}"
正常時に返されるデータを表示するにはここをクリック...
[
    {
        "repo": "2team/grouptest",
        "privilege": "write",
        "group": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "Developers",
            "members": [
                {
                    "username": "buserbb",
                    "first_name": "B",
                    "last_name": "userbb",
                    "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                    "is_team": false
                }
            ],
            "slug": "developers"
        },
        "repository": {
            "owner": {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F6bc30a724121%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "is_team": true
            },
            "name": "grouptest",
            "slug": "grouptest"
        }
    }
]

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

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

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

viewer-release-management

たとえば、以下のように呼び出します。

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

Revokes the privileges of the group  mcatalbasdevelopers from the test repository.

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

On success, this call returns HTTP/1.1 204 NO CONTENT.

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

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

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント。
group_owner はい グループを所有するアカウント。
group_slug はい グループのスラッグ。スラッグは Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることでスラッグを作成します。グループに "Viewer Release Management" という名前をつけると、スラッグは以下のようになります。

viewer-release-management

たとえば、以下のように呼び出します。

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

Revokes privileges of the group mtcatalbas/developers from all of mtcalbas' repositories:

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

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

最終更新日 2018 年 6 月 14 日

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

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.