Bitbucket Cloud の使用を開始する
Bitbucket Cloud を初めてお使いですか? 新規ユーザー用のガイドをご利用ください。
groups エンドポイント
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
概要
groups エンドポイントは、Bitbucket Cloud のユーザー グループに関する情報の確認、新規作成、メンバーシップの更新、および削除のための機能を提供します。グループは個人アカウントとチーム アカウントの両方で定義できます。個人アカウントでグループ情報を管理するには、呼び出し元がアカウントの管理者権限で認証する必要があります。チーム アカウントでグループを管理するには、呼び出し元がチームの管理者権限を持つチーム メンバーとして認証する必要があります。グループには以下のフィールドが含まれます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
"name": "Administrators",
"permission": "admin",
"email_forwarding_disabled":false,
"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"
}以下の表は、groups 構造の各フィールドについて説明しています。
フィールド | 説明 |
|---|---|
name | グループの作成時に指定されたグループの表示名。 |
permission | グループに割り当てられた権限。 |
members | ユーザー プロファイルの配列 (各グループ メンバーに対して 1 つ)。グループは空である場合もあります。 |
owner | グループの所有者を表すユーザー プロファイル。 |
slug | グループの識別子。slug は Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にして slug を作成します。グループに "Viewer Release Management" という名前をつけると、slug は以下のようになります。 viewer-release-management |
一致するグループの一覧の GET
1
GET https://api.bitbucket.org/1.0/groups?{filter}&{filter}&...1 つ以上のフィルターに一致するグループの一覧を取得します。グループを表示するには、呼び出し元はグループを参照するために、管理者権限またはグループ メンバーとして認証する必要があります。このメソッドでは、指定された 1 つ以上のフィルターに一致する、表示可能なすべてのグループが取得されます。グループが呼び出し元によって所有されているか、呼び出し元がそのメンバーである場合、呼び出し元でグループを表示可能です。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
filter | はい | 以下の形式のフィルター: 1
group={ownername}/{group_slug} |
グループの一覧の GET
1
GET https://api.bitbucket.org/1.0/groups/{workspace_id}/ワークスペースのグループの一覧を取得します。グループを表示するには、呼び出し元はグループを参照するために、ワークスペースの管理者権限またはグループ メンバーとして認証する必要があります。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
新しいグループの POST
1
POST https://api.bitbucket.org/1.0/groups/{workspace_id} --data "name=string"新しいグループを作成します。呼び出し元はアカウントのグループにアクセスするために、アカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
name | はい | グループの名前。 |
例
designers というグループを作成する場合、次のようにします。
1
curl --request POST --user username:password https://api.bitbucket.org/1.0/groups/username@example.com/ --data "name=designers"グループの更新の PUT
1
PUT https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/ --header "Accept: application/json" --data '{"name":"developers","permission":"write":true}'既存のグループ リソースを更新します。呼び出し元はアカウントの管理者権限で認証する必要があります。このコマンドは、JSON リクエスト ペイロードを期待します。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
name | いいえ | グループの名前。 |
group_slug | はい | グループのスラッグ。 |
permission | いいえ | read、write、または admin |
例
以下の例では、designers グループの名前を developers に変更し、新しく作成されたすべてのリポジトリについて、既定の書き込みアクセス権をグループに付与しています。
1
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":true}'PUT リクエストを作成する場合、--header "Content-Length: 0" の追加が必要な場合があります。
グループの削除
1
DELETE https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/ グループを削除します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
group_slug | はい | グループのスラッグ。 |
この呼び出しでは、正常に完了すると HTTP/1.1 204 NO CONTENT が返されます。
グループ メンバーの GET
1
GET https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/membersグループのメンバーシップを取得します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
group_slug | はい | グループのスラッグ。 |
グループへの新しいメンバーの PUT
1
PUT https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/members/{uuid}/ --data '{}'グループにメンバーを追加します。この呼び出しでは、ヘッダーに Content-Type: application/json が必要です。また、空の --data {} 要素を提供する必要があります。グループにアクセスするには、呼び出し元がワークスペースの管理者権限で認証する必要があります。このメソッドには次のパラメーターがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
group_slug | はい | グループのスラッグ。 |
uuid | はい | アカウントの一意の識別子。 |
例
ユーザー名が brao であるメンバーをグループ developers に追加する場合、次のようにします。
1
curl --request PUT --user username:password --header "Content-Type: application/json" https://api.bitbucket.org/1.0/groups/test_workspace/developers/members/%7Bc423e13e-b541-3e77-b363-3e0b458u8226%7D/ --data '{}'応答は次のようになります。
1
2
3
4
5
6
{
"display_name": "Atlassian Tutorials",
"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
1
DELETE https://api.bitbucket.org/1.0/groups/{workspace_id}/{group_slug}/members/{uuid}グループからメンバーを削除します。呼び出し元はアカウントの管理者権限で認証する必要があります。このメソッドには次のパラメータがあります。
パラメーター | 必須かどうか | 説明 |
|---|---|---|
workspace_id | はい | ワークスペース ID。 |
group_slug | はい | グループのスラッグ。 |
uuid | はい | アカウントの一意の識別子。 |
この呼び出しでは、正常に完了すると HTTP/1.1 204 NO CONTENT が返されます。
この内容はお役に立ちましたか?