oauth リソース

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

oauth リソースを使用して、独自の OAuth コンシューマーを作成します。Oauth は認証用のオープン スタンダードです。Oauth を使用すると、Bitbucket をサービス プロバイダーとして使用できます。この API を使用するか、[アカウント] > [統合アプリケーション] ページで OAuth コンシューマー オプションを使用して、コンシューマーを作成できます。コンシューマーを作成する際、Bitbucket はユーザー用に一意のコンシューマー キーとシークレットを生成します。ユーザー自身がこれらを提供または変更することはできません。コンシューマーは次の構造を持ちます。

{
        "name": "bitbucket REST documentation",
        "url": null,
        "secret": "5X8xtavvLndf2XB4c9wfALBLRrrBYR5F",
        "key": "h3WHQGSvnWCRtSN1fp",
        "id": 167,
        "description": ""
}

この構造のフィールドは次のとおりです。

フィールド 説明
name ユーザーに表示されるキーの名前。キーを作成するためにはこのフィールドが必須です。
url キーを使用するサービスの場所 (オプション)。
secret これは Bitbucket サービスによって生成されるため、ユーザーが作成 / 変更することはできません。
key これは Bitbucket サービスによって生成されるため、ユーザーが作成 / 変更することはできません。
id コンシューマーの一意の ID。これは Bitbucket によって生成され、ユーザーが変更することはできません。
description ユーザーに表示されるキーの説明。

OAuth コンシューマーを使用すると、サードパーティ製アプリケーションで Bitbucket と連携して、エンドユーザーの代理として認証リクエストを行うことができます。

Bitbucket サービスでは以下がサポートされます。

  • OAuth 1.0a と HMAC-SHA1 (共有秘密) 署名。3-Legged と 2-Legged OAuth の両方を使用します。RSA-SHA1 (公開 / 秘密キー) は現在、サポートされていません。
  • OAuth 2 および RFC-6749 の 4 つの許可フローすべて

コンシューマーは Bitbucket アカウントに紐づけられます。これは 2-Legged リクエストを行う場合にのみ重要です。2-legged リクエストにはエンドユーザー固有のアクセス トークンがありません。Bitbucket サービスは、コンシューマーを所有するユーザーとしてこれらを認証します。

エンコード

This resource accepts both regular form posts (Content-Type:  application/x-www-form-urlencoded) as illustrated above, but also JSON request bodies. JSON request bodies should follow  the same layout as the responses from the examples below. When using JSON request bodies, make sure to send the appropriate Content-Type: application/json request header.

すべての OAuth コンシューマーの GET

ユーザー アカウントで現在設定されている OAuth コンシューマーを取得します。この呼び出しには認証が必要です。呼び出し元は個人アカウントの所有者、またはチーム アカウントの管理権限を持つユーザーとして認証する必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須 説明
accountname はい 個人またはチーム アカウントの名前。
GET https://api.bitbucket.org/1.0/users/{accountname}/consumers
ここをクリックして展開...
[
    {
        "id": 165,
        "secret": "pMDhe2QMGzNEyVAuH46nnjfNULa8Sq8R",
        "name": "fdhgfgAASD",
        "key": "EE8npgGuWp9Q2ykcaE",
        "description": ""
    },
    {
        "id": 166,
        "secret": "5XQT2yfYrwuW5M8Sn9Euh9VqtwHenjw4",
        "name": "fdhgfgAASD",
        "key": "mkHxpx9dqYPkZdw8WT",
        "description": ""
    }
]


新しい OAuth コンシューマーの POST

個人またはチーム アカウントに既存の OAuth コンシューマーを作成します。呼び出し元は個人アカウントの所有者、またはチーム アカウントの管理権限を持つユーザーとして認証する必要があります。これが成功すると、201 ステータス コードと、新しいコンシューマーのコンテンツが返されます。コンシューマーを作成する際、Bitbucket はユーザーに一意のコンシューマー キーとシークレットを作成します。これらを自身で提供または変更することはできません。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
name はい キーの表示名。
description いいえ キーの説明。
url いいえ キーを使用するサービスの場所。
POST https://api.bitbucket.org/1.0/users/{accountname}/consumers --data name=value&description=value&url=value"
{
    "id": 165,
    "secret": "pMDhe2QMGzNEyVAuH46nnjfNULa8Sq8R",
    "name": "MyApp",
    "key": "EE8npgGuWp9Q2ykcaE",
    "description": "Description of MyApp"
}

すべての OAuth コンシューマーの更新

個人またはチーム アカウントの既存の OAuth コンシューマーを更新します。呼び出し元は個人アカウントの所有者、またはチーム アカウントの管理権限を持つユーザーとして認証する必要があります。コンシューマーを作成する際、Bitbucket はユーザーに一意のコンシューマー キーとシークレットを作成します。これらを自身で提供または変更することはできません。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
name はい キーの表示名。
description いいえ キーの説明。
url いいえ キーを使用するサービスの場所。
key_id はい 更新するキーの ID。

If you do not supply a description or url, the system removes the content of that field.

PUT https://api.bitbucket.org/1.0/users/{accountname}/consumers/{key_id} --data name=value&description=value&url=value"
$ curl --request PUT --user evzijst:password https://api.bitbucket.org/1.0/users/evzijst/consumers/165 --data name=MyApp2
{
    "id": 165,
    "secret": "pMDhe2QMGzNEyVAuH46nnjfNULa8Sq8R",
    "name": "MyApp2",
    "key": "EE8npgGuWp9Q2ykcaE",
    "description": ""
}

OAuth コンシューマーの DELETE

個人またはチーム アカウントの既存の OAuth コンシューマーを削除します。呼び出し元は個人アカウントの所有者、またはチーム アカウントの管理権限を持つユーザーとして認証する必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
key_id はい 更新するキーの ID。
DELETE  https://api.bitbucket.org/1.0/users/{accountname}/consumers/{key_id}




最終更新日 2018 年 6 月 14 日

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

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