groups エンドポイント

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

The groups endpoint provides functionality for querying information about Bitbucket Cloud user groups, creating new ones, updating memberships, and deleting them. Both individual and team accounts can define groups.  To manage group information on an individual account, the caller must authenticate with administrative rights on the account. To manage groups for a team account, the caller must authenticate as a team member with administrative rights on the team. A group contains the following fields:

{
        "name": "Administrators",
        "permission": "admin",
        "auto_add": true,
        "members": [
            {
                "username": "2team",
                "first_name": "2 Team",
                "last_name": "",
                "is_team": true,
                "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F90cccbaebb4e%2Fimg%2Fteam_no_avatar_32.png&s=32",
                "resource_uri": "/1.0/users/2team"
            },
            {
                "username": "buserbb",
                "first_name": "B",
                "last_name": "userbb",
                "is_team": false,
                "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                "resource_uri": "/1.0/users/buserbb"
            }
        ],
        "owner": {
            "username": "2team",
            "first_name": "2 Team",
            "last_name": "",
            "is_team": true,
            "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F90cccbaebb4e%2Fimg%2Fteam_no_avatar_32.png&s=32",
            "resource_uri": "/1.0/users/2team"
        },
        "slug": "administrators"
 }

These following table describes each of the fields in a groups structure.

フィールド 説明
name グループの作成時に指定されたグループの表示名。
permission グループに割り当てられた権限。
auto_add 新しいリポジトリがこのグループを自動的に受け取るかどうかを示すブール値のフラグ。
members ユーザー プロファイルの配列 (各グループ メンバーに対して 1 つ)。グループは空である場合もあります。
owner グループの所有者を表すユーザー プロファイル。
slug

The group identifier. The slug is an identifier constructed by the Bitbucket service. Bitbucket creates a slug by converting spaces to dashes and making all text lower case. So, if you name a group Viewer Release Management then its slug is:

viewer-release-management

一致するグループの一覧の GET

1 つ以上のフィルターに一致するグループの一覧を取得します。グループを表示するには、呼び出し元はグループを参照するために、管理者権限またはグループ メンバーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
filter はい

以下の形式のフィルター:

group={ownername}/{group_slug}

このメソッドでは、指定された 1 つ以上のフィルターに一致する、表示可能なすべてのグループが取得されます。グループが呼び出し元によって所有されているか、呼び出し元がそのメンバーである場合、呼び出し元でグループを表示可能です。

GET https://api.bitbucket.org/1.0/groups?{filter}&{filter}&...
正常時に返されるデータを表示するにはここをクリック...
[
    {
        "name": "developers",
        "permission": "read",
        "auto_add": false,
        "members": [
            {
                "username": "jstepka",
                "first_name": "Justen",
                "last_name": "Stepka",
                "avatar": "https://secure.gravatar.com/avatar/12e5043280f67465b68ac42985082498?d=identicon&s=32",
                "resource_uri": "/1.0/users/jstepka"
            },
            {
                "username": "detkin",
                "first_name": "Dylan",
                "last_name": "Etkin",
                "avatar": "https://secure.gravatar.com/avatar/e1ef8ef737e394a17ffbc27c889c2b22?d=identicon&s=32",
                "resource_uri": "/1.0/users/detkin"
            }
        ],
        "owner": {
            "username": "baratrion",
            "first_name": "Mehmet S",
            "last_name": "Catalbas",
            "avatar": "https://secure.gravatar.com/avatar/55a1369161d3a648729b59cabf160e70?d=identicon&s=32",
            "resource_uri": "/1.0/users/baratrion"
        },
        "slug": "developers"
    }
]

グループの一覧の GET

アカウントのグループの一覧を取得します。グループを表示するには、呼び出し元はグループを参照するために、管理者権限またはグループ メンバーとして認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。ユーザ名または有効なメール アドレスを指定できます。
GET https://api.bitbucket.org/1.0/groups/{accountname}/
正常時に返されるデータを表示するにはここをクリック...
[
    {
        "name": "developers",
        "permission": "read",
        "auto_add": false,
        "members": [
            {
                "username": "jstepka",
                "first_name": "Justen",
                "last_name": "Stepka",
                "avatar": "https://secure.gravatar.com/avatar/12e5043280f67465b68ac42985082498?d=identicon&s=32",
                "resource_uri": "/1.0/users/jstepka"
            },
            {
                "username": "detkin",
                "first_name": "Dylan",
                "last_name": "Etkin",
                "avatar": "https://secure.gravatar.com/avatar/e1ef8ef737e394a17ffbc27c889c2b22?d=identicon&s=32",
                "resource_uri": "/1.0/users/detkin"
            }
        ],
        "owner": {
            "username": "baratrion",
            "first_name": "Mehmet S",
            "last_name": "Catalbas",
            "avatar": "https://secure.gravatar.com/avatar/55a1369161d3a648729b59cabf160e70?d=identicon&s=32",
            "resource_uri": "/1.0/users/baratrion"
        },
        "slug": "developers"
    }
]

新しいグループの POST

新しいグループを作成します。呼び出し元はアカウントのグループにアクセスするために、アカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。ユーザ名または有効なメール アドレスを指定できます。
name はい グループの名前。

To create a group called designers:

curl --request POST --user username:password https://api.bitbucket.org/1.0/groups/username@example.com/ --data "name=designers"
POST https://api.bitbucket.org/1.0/groups/{accountname}  --data "name=string"
ここをクリックして展開...
{
    "name": "the designers",
    "permission": null,
    "auto_add": false,
    "members": [],
    "owner": {
        "username": "2team",
        "first_name": "2 Team",
        "last_name": "",
        "is_team": true,
        "avatar": "https://secure.gravatar.com/avatar/15827007bdb707832ded90a612750cfb?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F90cccbaebb4e%2Fimg%2Fteam_no_avatar_32.png&s=32",
        "resource_uri": "/1.0/users/2team"
    },
    "slug": "the-designers"
}


グループの更新

既存のグループ リソースを更新します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
name いいえ グループの名前。
group_slug はい グループのスラッグ。
auto_add いいえ ブール値。グループを自動的に追加する場合は true にします。
permission いいえ One of read, write, or admin.

This command expects a JSON request payload.  The following example changes the designers group's name to developers and grants default write access to the group for all newly created repositories.

curl --request PUT --user username:password https://api.bitbucket.org/1.0/groups/username@example.com/designers/ --header "Content-Type: application/json" --header "Accept: application/json" --data '{"name":"developers","permission":"write","auto_add":true}'
PUT https://api.bitbucket.org/1.0/groups/{accountname}/{group_slug}/  --header "Accept: application/json" --data '{"name":"developers","permission":"write","auto_add":true}'
正常時に返されるデータを表示するにはここをクリック...
{
    "name": "developers",
    "permission": "write",
    "auto_add": true,
    "members": [],
    "owner": {
        "username": "baratrion",
        "first_name": "Mehmet S",
        "last_name": "Catalbas",
        "avatar": "https://secure.gravatar.com/avatar/55a1369161d3a648729b59cabf160e70?d=identicon&s=32",
        "resource_uri": "/1.0/users/baratrion"
    },
    "slug": "developers"
}

You may need to add --header "Content-Length: 0" when making PUT requests.

グループの削除

グループを削除します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
group_slug はい グループのスラッグ。
DELETE  https://api.bitbucket.org/1.0/groups/{accountname}/{group_slug}/ 

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

グループ メンバーの GET

グループのメンバーシップを取得します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
group_slug はい グループのスラッグ。
GET https://api.bitbucket.org/1.0/groups/{accountname}/{group_slug}/ members
正常時に返されるデータを表示するにはここをクリック...
[
    {
        "username": "jstepka",
        "first_name": "Justen",
        "last_name": "Stepka",
        "avatar": "https://secure.gravatar.com/avatar/12e5043280f67465b68ac42985082498?d=identicon&s=32",
        "resource_uri": "/1.0/users/jstepka"
    },
    {
        "username": "detkin",
        "first_name": "Dylan",
        "last_name": "Etkin",
        "avatar": "https://secure.gravatar.com/avatar/e1ef8ef737e394a17ffbc27c889c2b22?d=identicon&s=32",
        "resource_uri": "/1.0/users/detkin"
    }
]

グループへの新しいメンバーの PUT

Adds a member to a group. This call requires the  Content-Type: application/json  in the header.  You should also supply an empty --data {} element. Finally, the caller must authenticate with administrative rights on an account to access its groups. This method has the following parameters:

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
group_slug はい グループのスラッグ。
membername はい 個人アカウント。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。アカウント名では大文字と小文字が区別されます。

To add a member with the username brao to the group developers:

curl --request PUT --user username:password --header "Content-Type: application/json" https://api.bitbucket.org/1.0/groups/username/developers/members/brao/ --data '{}'
PUT https://api.bitbucket.org/1.0/groups/{accountname}/{group_slug}/members/{membername}
ここをクリックして展開...
{
    "username": "atlassian_tutorial",
    "first_name": "Atlassian Tutorials",
    "last_name": "",
    "is_team": true,
    "avatar": "https://secure.gravatar.com/avatar/eb4e0ad6934518b3e335345a4ceeef21?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F5441e467b5e2%2Fimg%2Fteam_no_avatar_32.png&s=32",
    "resource_uri": "/1.0/users/atlassian_tutorial"
}

メンバーの DELETE

グループからメンバーを削除します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
group_slug はい グループのスラッグ。
membername はい 個人アカウント名。アカウント名またはアカウントのプライマリ メール アドレスを指定できます。
DELETE  https://api.bitbucket.org/1.0/groups/{accountname}/{group_slug}/members/{membername}

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

謝辞

このページの改良のために追加のテストと解説を提供してくれた Anthony Steiner 氏に感謝します。


最終更新日 2018 年 6 月 14 日

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

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