consumers リソース

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018. All 1.0 APIs will be removed from the REST API permanently on 12 April 2019. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

概要

A consumer is an application authorized to integrate with a Bitbucket account. Account owners or team administrators can give third-party web applications access to a Bitbucket individual account or a team.  By integrating an application with Bitbucket, you authorize that account to act as your user.  So, for example, if you have read/write access to all of the account, the application does as well.  Anything you could do when logged into Bitbucket, that application can also do.

As a consumer is associated with an account, all calls to retrieve consumer information require the caller to authenticate as an owner or administrator on the account.   A consumer instance has the following fields:

{
    "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

Updates an individual consumer for an account.  You must supply the consumer's name parameter.

パラメーター
必須かどうか
説明
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}

This call returns 204 No Content on success.

最終更新日 2018 年 6 月 14 日

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

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