consumers リソース

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

consumer は、Bitbucket アカウントと連携する権限が与えられているアプリケーションです。アカウント所有者またはチームの管理者は、サードパーティ製の web アプリケーションに、Bitbucket の個人またはチーム アカウントへのアクセス権を与えることができます。アプリケーションを Bitbucket と連携させると、そのアカウントは対象のユーザーとして操作を実行します。たとえば、ユーザーがアカウントのすべてに対して読み取り / 書き込みアクセス権を持っている場合、アプリケーションも同様の権限を持つことになります。ユーザーが Bitbucket へのログイン中に実行できるすべての操作をアプリケーションも実行できます。

コンシューマーはアカウントに関連付けられているため、コンシューマー情報を取得するための呼び出しでは常に、呼び出し元がアカウントの所有者または管理者であることを認証する必要があります。consumer インスタンスには次のフィールドがあります。

{
    "description": "", 
    "id": 22779, 
    "key": "y9spXwJKNcygKdWBH2", 
    "name": "TestDVCS", 
    "secret": "bQWTaGRpT9RhB24TQWYP9M2LcvZy9Pkw", 
    "url": ""
} 

これらのフィールドには次の値があります。

フィールド 説明
description この連携の説明。この値は null に設定できます。
id Bitbucket によって割り当てられる識別子。
key Bitbucket によって生成される OAuth キー。
name コンシューマーの表示名。
secret Bitbucket によって生成される OAuth シークレット。
url コンシューマーの URL。この値は null に設定できます。


アカウントのコンシューマー一覧の GET

アカウントと連携しているコンシューマーの配列が返されます。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。

GET https://api.bitbucket.org/1.0/users/{accountname}/consumers

ここをクリックして展開...
[
    {
        "description": "", 
        "id": 22779, 
        "key": "y9spXwJKNcygKdWBH2", 
        "name": "TestDVCS", 
        "secret": "bQWTaGRpT9RhB24TQWYP9M2LcvZy9Pkw", 
        "url": ""
    }, 
    {
        "description": "test", 
        "id": 27209, 
        "key": "wBLY2HU5yjcD4ncmLj", 
        "name": "test", 
        "secret": "Hw8TAqhpbPHhbBBCFyD8HPS4nm25EGZp", 
        "url": "www.slate.com"
    }
]

コンシューマーの GET

アカウントの個別のコンシューマーを取得します。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。
id はい キーの識別子

 GET https://api.bitbucket.org/1.0/users/{accountname}/{id}

ここをクリックして展開...
{
    "description": "", 
    "id": 22779, 
    "key": "y9spXwJKNcygKdWBH2", 
    "name": "TestDVCS", 
    "secret": "bQWTaGRpT9RhB24TQWYP9M2LcvZy9Pkw", 
    "url": ""
} 

コンシューマーの更新の PUT

アカウントの個別のコンシューマーを更新します。コンシューマーの name パラメーターを指定する必要があります。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。
id はい キーの識別子
name はい コンシューマーの名前。
description いいえ コンシューマーの説明。
url いいえ コンシューマーの URL。

 PUT https://api.bitbucket.org/1.0/users/{accountname}/{id} -d"name={name}&description={string}&url={url}"

ここをクリックして展開...
{
    "description": "here", 
    "id": 22774, 
    "key": "y6spXwJKNcygKdWBH2", 
    "name": "ralph", 
    "secret": "bQWTaGRpT9RhB24TQWYP9M2LcvZy6Pkw", 
    "url": "foobar.com"
}

コンシューマーの DELETE

個々のコンシューマーをアカウントから削除します。

パラメータ
必須かどうか
説明
accountname はい チームまたは個人のアカウント名。
id はい キーの識別子

DELETE https://api.bitbucket.org/1.0/users/{accountname}/{id}

この呼び出しが正常に完了すると、204 No Content が返されます。

最終更新日 2018 年 6 月 14 日

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

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