emails リソース

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

1 つのアカウントはに 1 つ以上のメール アドレスを関連付けることができます。メール アドレスを一覧表示、変更、または作成するには、このエンドポイントを使用します。このリソースには以下のフィールドがあります。

フィールド 説明
active ユーザーがメール アドレスを確認したこと (true) を示すブール値です。このフラグが false の場合、Bitbucket では、アカウントへのチェンジセットのリンクなどにメール アドレスを使用しません。
email メール アドレス。
primary メール アドレスがプライマリであること (true) を示すブール値。プライマリ アドレスはそのアカウントのメインの連絡先メール アドレスです。アカウントに複数のメール アドレスがある場合、1 つのアドレスのみをプライマリとすることができます。

ユーザーのメール アドレスの一覧の GET

アカウントに関連付けられたメール アドレスを取得します。この呼び出しには認証が必要です。個人アカウントとチーム アカウントで返されるフィールド候補は同じです。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須 説明
accountname はい 個人またはチーム アカウントの名前。
GET https://api.bitbucket.org/1.0/users/{accountname}/emails
ここをクリックして展開...
[
    {
        "active": true,
        "email": "2team.bb@gmail.com",
        "primary": true
    },
    {
        "active": false,
        "email": "ourteam@gmail.com",
        "primary": false
    }
]

メール アドレスの GET

アカウントに関連付けられた個々のメール アドレスを取得します。この呼び出しには認証が必要です。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須 説明
accountname はい 個人またはチーム アカウントの名前。
email_address はい 取得するメール アドレス。
GET https://api.bitbucket.org/1.0/users/{accountname}/emails/{email_address}
ここをクリックして展開...
{
        "active": false,
        "email": "ourteam@gmail.com",
        "primary": false
}

新しいメール アドレスの POST

アカウントにメール アドレスを追加します。この呼び出しには認証が必要です。アカウントに複数のメール アドレスがある場合、以下の PUT コールを使用して、アドレスの 1 つをプライマリに設定することができます。この呼び出しでは、次のパラメーターを使用します。

パラメータ 必須 説明
accountname はい 個人またはチーム アカウントの名前。
email_address はい 取得するメール アドレス。

アドレスを追加すると、Bitbucket は新しいアドレスにアクティベーション メールを送信します。ユーザーがメールのアクティベーション リンクをクリックすると、アドレスの active が true に設定され、アドレスを使用できるようになります。POST コールを再度実行すると、Bitbucket は新しいリンクを含む新しい確認メールを送信し、active 値が false に設定されます。新しく送信されたアクティベーション リンクは過去のメール内のリンクよりも優先されます。

キャッシュにより、サイト上のすべての関連ページで新しいアドレスの反映に時間がかかる場合があります。

POST https://api.bitbucket.org/1.0/users/{accountname}/emails/{email_address} --data"email=value"
ここをクリックして展開...
[
    {
        "active": true,
        "email": "2team.bb@gmail.com",
        "primary": true
    },
    {
        "active": false,
        "email": "ourteam@gmail.com",
        "primary": false
    }
]

メール アドレスの更新

アカウントに関連付けられた 1 つのメール アドレスをプライマリに設定します。プライマリ メール アドレスは、そのアカウントのメインの連絡先となります。アカウントでは 1 つのアドレスのみをプライマリにすることができます。このコールに先立ってほかのアドレスがプライマリに設定されていた場合、そのアドレスはコール以降はプライマリではなくなります。この呼び出しには認証が必要であり、次のパラメーターを使用します。

パラメータ 必須 説明
accountname はい 個人またはチーム アカウントの名前。
email_address はい 取得するメール アドレス。
PUT https://api.bitbucket.org/1.0/users/{accountname}/emails/{email_address} --data "primary=true"
ここをクリックして展開...
{
        "active": true,
        "email": "ourteam@gmail.com",
        "primary": true
}
最終更新日 2018 年 6 月 14 日

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

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