privileges エンドポイント

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

Use the privileges endpoint to manage Bitbucket Cloud user privileges (permissions). It allows you to grant specific users access to read, write and or administer your repositories. Only the repository owner, a team account administrator, or an account with administrative rights on the repository can can query or modify repository privileges. To manage group access to your repositories, use the group-privileges Endpoint and to manage privilege settings for team accounts, use the privileges Resource.  

The privileges endpoint has the following structure:

    "repo": "tutorials/tutorials.bitbucket.org",
    "privilege": "write",
    "user": {
      "username": "cburwinkle",
      "first_name": "Christine",
      "last_name": "Burwinkle",
      "display_name": "Christine Burwinkle",
      "is_team": false,
      "avatar": "https://secure.gravatar.com/avatar/07155386777a423e803a72cd80dfa3fd?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
    },
    "repository": {
      "owner": {
        "username": "tutorials",
        "first_name": "first name",
        "last_name": "last",
        "display_name": "first name last",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/0bc5bd490000b8e63c35c0f54e667b9e?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
      },
      "name": "tutorials.bitbucket.org",
      "slug": "tutorials.bitbucket.org"
    }
  }

The fields in the privileges structure are the following:

フィールド 説明
repo

リポジトリの識別子で、次の形式で表されます。

{owner}/{repo_slug}
privilege

ユーザーに付与された権限です。次のいずれかになります。

  • admin
  • read
  • write
user ユーザーのプロファイルです。
repository リポジトリのプロファイルです。

To obtain a list of teams you are a member of, query the  /user/privileges  endpoint.  To list groups with access, see group-privileges Endpoint.

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

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/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/privileges/mcatalbas/?private=true

リポジトリに付与された個人アカウントの権限一覧を取得する

リポジトリに付与された権限の一覧を取得します。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。権限が付与された個人アカウントがリポジトリに存在しない場合、空の配列 [] が返されます。グループの権限を取得したい場合は group-privileges エンドポイントを利用します。

このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
repo_slug はい リポジトリの識別子。
filter いいえ

特定の権限のフィルタリング。次の値を利用できます。

  • read
  • write
  • admin

Lower level privileges encompass the higher levels; admin and write already have read access. To see every individual account with any access, specify the read filter.

GET https://api.bitbucket.org/1.0/privileges/{accountname}/{repo_slug}
ここをクリックして展開...

In the code below, the users jespern and detkin have read access, user davidchambers has write access, and nvenegas has full administrative privileges.

[
  {
    "repo": "tutorials/tutorials.bitbucket.org",
    "privilege": "write",
    "user": {
      "username": "cburwinkle",
      "first_name": "Christine",
      "last_name": "Burwinkle",
      "display_name": "Christine Burwinkle",
      "is_team": false,
      "avatar": "https://secure.gravatar.com/avatar/07155386777a423e803a72cd80dfa3fd?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
    },
    "repository": {
      "owner": {
        "username": "tutorials",
        "first_name": "first name",
        "last_name": "last",
        "display_name": "first name last",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/0bc5bd490000b8e63c35c0f54e667b9e?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
      },
      "name": "tutorials.bitbucket.org",
      "slug": "tutorials.bitbucket.org"
    }
  },
  {
    "repo": "tutorials/tutorials.bitbucket.org",
    "privilege": "read",
    "user": {
      "username": "sgriffin",
      "first_name": "Susan",
      "last_name": "Griffin",
      "display_name": "Susan Griffin",
      "is_team": false,
      "avatar": "https://secure.gravatar.com/avatar/b48e3c3f4f60961f2689de516736a224?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
    },
    "repository": {
      "owner": {
        "username": "tutorials",
        "first_name": "first name",
        "last_name": "last",
        "display_name": "first name last",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/0bc5bd490000b8e63c35c0f54e667b9e?d=https%3A%2F%2Fd3oaxc4q5k2d6q.cloudfront.net%2Fm%2F13b5a9275dc9%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32"
      },
      "name": "tutorials.bitbucket.org",
      "slug": "tutorials.bitbucket.org"
    }
]

1 つの個人アカウントの権限を取得する

1 つの個人アカウントの権限の一覧を取得します。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
repo_slug はい リポジトリの識別子。
privilege_account はい 権限の表示対象のアカウント。
GET https://api.bitbucket.org/1.0/privileges/{accountname}/{repo_slug}/{privilege_account}
ここをクリックして展開...
[
    {
        "repo": "evzijst/test",
        "privilege": "admin",
        "user": {
            "username": "nvenegas",
            "first_name": "Nicolas",
            "last_name": "Venegas"
        }
    }
]

1 アカウントのすべてのリポジトリから権限一覧を取得する

1 つのアカウントのすべてのリポジトリから、権限一覧を取得します。権限が付与された個人アカウントが存在しないリポジトリは、一覧に含まれません。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
filter いいえ

特定の権限のフィルタリング。次の値を利用できます。

  • read
  • write
  • admin
GET https://api.bitbucket.org/1.0/privileges/{accountname}
ここをクリックして展開...
[
    {
        "repo": "buserbb/mybuserrepo",
        "privilege": "write",
        "user": {
            "username": "tutorials",
            "first_name": "",
            "last_name": "",
            "avatar": "https://secure.gravatar.com/avatar/0bc5bd490000b8e63c35c0f54e667b9e?d=identicon&s=32",
            "is_team": false
        },
        "repository": {
            "owner": {
                "username": "buserbb",
                "first_name": "B",
                "last_name": "userbb",
                "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
                "is_team": false
            },
            "name": "mybuserrepo",
            "slug": "mybuserrepo"
        }
    }
]

新しい権限を設定する

リポジトリでアカウントに対して権限を付与します。このメソッドでは、ユーザーの権限をアップグレードすることもダウングレードすることもできます。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
repo_slug はい リポジトリの識別子。
group_slug はい グループのスラッグ。
privilege_account はい 権限の表示対象のアカウント。
privilege はい

割り当てる権限。有効な値は以下のとおりです。

  • read
  • write
  • admin

To grant user brodie write access to the test repo,  PUT on /1.0/privileges/evzijst/test/brodie with the string write as request body:

$ curl --request PUT --user evzijst:password https://api.bitbucket.org/1.0/privileges/evzijst/test/brodie --data write

成功した場合、200 ステータス コードと、空のレスポンス ボディが返されます。

$ curl --request PUT --user evzijst:password https://api.bitbucket.org/1.0/privileges/evzijst/test/brodie --data read


PUT  https://api.bitbucket.org/1.0/privileges/{accountname}/{repo_slug}/{privilege_account}--data {read}
ここをクリックして展開...
[
    {
        "repo": "tutorials/mydvcsproject",
        "privilege": "write",
        "user": {
            "username": "atlassian_tutorial",
            "first_name": "Atlassian Tutorials",
            "last_name": "",
            "avatar": "https://secure.gravatar.com/avatar/eb4e0ad6934518b3e335345a4ceeef21?d=https%3A%2F%2Fdwz7u9t8u8usb.clou
dfront.net%2Fm%2F8319cb1efac9%2Fimg%2Fteam_no_avatar_32.png&s=32",
            "is_team": true
        },
        "repository": {
            "owner": {
                "username": "tutorials",
                "first_name": "",
                "last_name": "",
                "avatar": "https://secure.gravatar.com/avatar/0bc5bd490000b8e63c35c0f54e667b9e?d=identicon&s=32",
                "is_team": false
            },
            "name": "mydvcsproject",
            "slug": "mydvcsproject"
        }
    }
]


リポジトリからアカウントの権限を削除する

リポジトリから 1 つのアカウントの権限を削除します。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
repo_slug はい リポジトリの識別子。
privilege_account はい 権限の表示対象のアカウント。
DELETE  https://api.bitbucket.org/1.0/privileges/{accountname}/{repo_slug}/{privilege_account}

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

1 つのリポジトリからすべての権限を削除する  

1 つのリポジトリからすべての権限を削除します。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。


パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
repo_slug はい リポジトリの識別子。
 
DELETE  https://api.bitbucket.org/1.0/privileges/{accountname}/{repo_slug}
  On success, this call returns HTTP/1.1 204 NO CONTENT.

すべてのリポジトリからすべての権限を削除する  

すべてのリポジトリからすべての権限を削除します。リポジトリ オーナー、チーム アカウント管理者、またはリポジトリの管理権限を持つユーザーのみが、この呼び出しを行えます。このメソッドには次のパラメータがあります。

パラメータ
必須かどうか
説明
accountname はい リポジトリ オーナー。
DELETE  https://api.bitbucket.org/1.0/privileges/{accountname}

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


最終更新日 2018 年 6 月 14 日

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

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