groups エンドポイント

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018, and were removed from the REST API permanently on 29 April 2019. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

Temporary support for limited 1.0 API resources

The 2.0 REST API will rely on the Atlassian Cloud Admin API for user and group management, but those API endpoints are not yet available. Until the Atlassian platform services are fully available in Bitbucket we will continue to support these 1.0 REST endpoints:

概要

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",
        "email_forwarding_disabled":false,
        "auto_add": true,
        "members": [
            {
                "display_name": "Justen Stepka",
                "account_id": "557057:016ad873-3455-3455-23443-233534545434",
                "is_team":false,
                "is_staff":false,
                "avatar": "https://secure.gravatar.com/avatar/12e5043",
                "resource_uri": "/1.0/users/jstepka",
                "nickname":"jstepka",
                "uuid":"{c423e13e-b541-3e77-b363-3e0b458u8226}
            }
        ],
        "owner": {
            "display_name": "Justen Stepka",
            "uuid":"{c423e13e-b541-3e77-b363-3e0b458u8226},
            "account_id": "557057:016ad873-3455-3455-23443-233534545434",
            "is_team":false,
            "avatar": "https://secure.gravatar.com/avatar/12e5043",
            "nickname":"jstepka",
            "resource_uri": "/1.0/users/jstepka"        
        },
        "slug": "administrators"
 }

This 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 lowercase. So, if you name a group Viewer Release Management then its slug is:

viewer-release-management

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

GET https://api.bitbucket.org/1.0/groups?{filter}&{filter}&...

Get a list groups matching one or more filters. The caller must authenticate with administrative rights or as a group member to view a group. This method gets all visible groups matching one of the provided filters. A group is visible to the caller if it is owned by the caller or if the caller is one of its members. This method has the following parameters:

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

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

group={ownername}/{group_slug}

グループの一覧の GET

GET https://api.bitbucket.org/1.0/groups/{workspace_id}/

Get a list of a groups for workspace. The caller must authenticate with administrative rights on the workspace or as a group member to view a group. This method has the following parameters:

パラメータ
必須かどうか
説明
workspace_id はい The workspace ID.

新しいグループの POST

POST https://api.bitbucket.org/1.0/groups/{workspace_id} --data "name=string"

Creates a new group. The caller must authenticate with administrative rights on an account to access its groups. This method has the following parameters:

パラメータ
必須かどうか
説明
workspace_id はい The workspace ID.
name はい グループの名前。

designers というグループを作成する場合、次のようにします。

curl --request POST --user username:password https://api.bitbucket.org/1.0/groups/username@example.com/ --data "name=designers"

PUT update a group

PUT https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/  --header "Accept: application/json" --data '{"name":"developers","permission":"write","auto_add":true}'


Updates an existing group resource. The caller must authenticate with administrative rights on the account. This command expects a JSON request payload. This method has the following parameters:

パラメータ
必須かどうか
説明
workspace_id はい The workspace ID.
name いいえ グループの名前。
group_slug はい グループのスラッグ。
auto_add いいえ ブール値。グループを自動的に追加する場合は true にします。
permission いいえ readwrite、または admin

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 リクエストを作成する場合、--header "Content-Length: 0" の追加が必要な場合があります。

グループの削除

DELETE  https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/ 

Deletes a group. The caller must authenticate with administrative rights on the account. This method has the following parameters:

パラメータ
必須かどうか
説明
workspace_id はい The workspace ID.
group_slug はい グループのスラッグ。


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

グループ メンバーの GET

GET https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/members

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

パラメータ
必須かどうか
説明
workspace_id
はい The workspace ID.
group_slug はい グループのスラッグ。

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

PUT https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/members/{uuid}

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. The caller must authenticate with administrative rights for a workspace to access its groups. This method has the following parameters:

パラメータ
必須かどうか
説明
workspace_id
はい The workspace ID.
group_slug はい グループのスラッグ。
uuid はい Unique identifier for an account.

ユーザー名が brao であるメンバーをグループ developers に追加する場合、次のようにします。

curl --request PUT --user username:password --header "Content-Type: application/json" https://api.bitbucket.org/1.0/groups/username/developers/members/brao/ --data '{}'


The response would like:

ここをクリックして展開...
{
    "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

DELETE https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/members/{uuid}

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

パラメータ
必須かどうか
説明
workspace_id はい The workspace ID.
group_slug はい グループのスラッグ。
uuid はい Unique identifier for an account.

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


最終更新日 2019 年 7 月 18 日

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

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