invitations リソース

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 APIs are deprecated

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 31 December 2018. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

概要

invitations は、アカウントの 1 つ以上のグループへの参加を求めるために外部メール アドレスに送信されるリクエストです。アカウントに対する管理者アクセス権を持っているユーザーは、他の人をグループに招待することができます。招待は次のフィールドで構成されています。

フィールド 説明
groups ユーザーが招待された 1 つ以上のアカウント グループ。
invited by 招待元ユーザーのユーザー プロファイル。
utc_sent_on 招待の作成時を示す UTC 値。
email 招待の外部メール

保留中の招待のリストを取得する

チームまたは個人のアカウントで保留中の招待のリストを取得します。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須 説明
accountname はい 個人またはチーム アカウントの名前。
GET https://api.bitbucket.org/1.0/users/{accountname}
ここをクリックして展開...

この呼び出しでは invitations 配列が返されます。

[
    {
        "groups": [
            "buserbb/testgroup"
        ],
        "invited_by": {
            "username": "buserbb",
            "first_name": "B",
            "last_name": "userbb",
            "is_team": false,
            "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
            "resource_uri": "/1.0/users/buserbb"
},
        "utc_sent_on": "2012-07-19 16:22:51+00:00",
        "email": "joe789@yahoo.com"
    },
    {
        "groups": [
            "buserbb/testgroup",
            "buserbb/newgroup"
        ],
        "invited_by": {
            "username": "buserbb",
            "first_name": "B",
            "last_name": "userbb",
            "is_team": false,
            "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
            "resource_uri": "/1.0/users/buserbb"
},
        "utc_sent_on": "2012-07-19 16:20:04+00:00",
        "email": "sally_jones@gmail.com"
    }
]

特定のメール アドレスについて保留中の招待を取得する

特定のメール アドレスについて、チームまたは個人のアカウントで保留中の招待のリストを取得します。アカウントに対する管理者アクセス権を持っているユーザーは、他の人をグループに招待することができます。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須 説明
accountname はい 個人またはチーム アカウントの名前。
email_address はい 取得するメール アドレス。
GET https://api.bitbucket.org/1.0/users/{accountname}/invitations/{email_address}
ここをクリックして展開...
{
    "groups": [
        "buserbb/testgroup",
        "buserbb/newgroup"
    ],
    "invited_by": {
        "username": "buserbb",
        "first_name": "B",
        "last_name": "userbb",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/b677e1e3bf1c781f852b288fd4b68480?d=identicon&s=32",
        "resource_uri": "/1.0/users/buserbb"
},
    "utc_sent_on": "2012-07-19 16:20:04+00:00",
    "email": "sally_jones@gmail.com"
}

グループ メンバーシップについて保留中の招待を取得する

アカウントのグループで特定のメールについて、保留中の招待があるかどうかをテストします。招待は、アカウントの 1 つ以上のグループへの参加を求めるために外部メール アドレスに送信されるリクエストです。アカウントに対する管理者アクセス権を持っているユーザーは、他の人をグループに招待することができます。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
group_owner はい グループを所有する個人またはチーム アカウントの名前。
group_slug はい グループの識別子。slug は Bitbucket サービスが構成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字に変換することで slug を作成します。
email_address はい 削除するメール アドレスの名前。
GET https://api.bitbucket.org/1.0/users/{accountname}/invitations/{email_address}/{group_owner}/{group_slug} 
ここをクリックして展開...

この呼び出しでは、招待が存在する場合、OK が返されます。

OK

それ以外は、Not Found が返されます。

Not found

グループに招待を送信する

特定のアカウント グループに招待を送信します。招待は、アカウントの 1 つ以上のグループへの参加を求めるために外部メール アドレスに送信されるリクエストです。アカウントに対する管理者アクセス権を持っているユーザーは、他の人をグループに招待することができます。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しではメール アドレスの検証は行いません。

この呼び出しを実行する場合、長さが 0 (ゼロ) であっても Content-Length ヘッダーを提供する必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
group_owner はい グループを所有する個人またはチーム アカウントの名前。
group_slug はい グループの識別子。slug は Bitbucket サービスが構成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字に変換することで slug を作成します。
email_address はい 削除するメール アドレスの名前。
PUT https://api.bitbucket.org/1.0/users/{accountname}/invitations/{email_address}/{group_owner}/{group_slug}
ここをクリックして展開...

この呼び出しでは、招待が正常に完了すると、OK が返されます。

OK

それ以外では、指定した group_slug が存在しない場合、Not Found が返されます。

Not found

メール アドレス別に保留中の招待を削除する

特定のメール アドレスについて、チームまたは個人アカウントで保留中の招待を削除します。招待は、アカウントの 1 つ以上のグループへの参加を求めるために外部メール アドレスに送信されるリクエストです。複数のグループで保留中の招待メールがある場合、その招待はすべてのグループから削除されます。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
email_address はい 削除するメール アドレスの名前。
DELETE https://api.bitbucket.org/1.0/users/{accountname}/invitations/{email_address}

この呼び出しでは、正常に完了すると 204 NO CONTENT が返されます。

グループ別に保留中の招待を削除する 

アカウントのグループの特定のメールについて、保留中の招待を削除します。招待は、アカウントの 1 つ以上のグループへの参加を求めるために外部メール アドレスに送信されるリクエストです。アカウントに対する管理者アクセス権を持っているユーザーは、他の人をグループに招待することができます。この呼び出しでは認証が必要で、呼び出す人はアカウントで管理権限を持っている必要があります。この呼び出しでは、次のパラメーターを使用します。

パラメーター 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
group_owner はい グループを所有する個人またはチーム アカウントの名前。
group_slug はい グループの識別子。slug は Bitbucket サービスが構成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字に変換することで slug を作成します。
email_address はい 削除するメール アドレスの名前。
  DELETE   https://api.bitbucket.org/1.0/users/{accountname}/invitations/{email_address}/{group_owner}/{group_slug} 

この呼び出しでは、正常に完了すると 204 NO CONTENT が返されます。


最終更新日 2018 年 1 月 14 日

この翻訳に満足しましたか?

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