invitations リソース

users エンドポイント - 1.0

このページの内容

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018, and were removed from the REST API permanently on 29 April 2019. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

Temporary support for limited 1.0 API resources

The 2.0 REST API will rely on the Atlassian Cloud Admin API for user and group management, but those API endpoints are not yet available. Until the Atlassian platform services are fully available in Bitbucket we will continue to support these 1.0 REST endpoints:

概要

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

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

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

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

Gets a list of pending invitations on a team or individual account. This call requires authorization and the caller must have administrative rights on the account. The call returns an array of invitations and takes the following parameters:

パラメータ 必須 説明
uuid はい Unique identifier for an account.

Issue an invitation to a group

curl  -X PUT https://api.bitbucket.org/1.0/users/{accountname}/invitations \
  --header "Content-Type: application/json" \
  --data '{"email":"address@example.com","group_slug":"my-group"}'

Issues an invitation to the specified account group. An invitation is a request sent to an external email address to participate in one or more of an account's groups. Any user with admin access to the account can invite someone to a group. This call requires authorization and the caller must have administrative rights on the account. This call does not validate the email address.

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

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

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

OK

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

Not found

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

curl -X DELETE https://api.bitbucket.org/1.0/users/{accountname}/invitations \
  --header "Content-Type: application/json" \
  --data '{"email":"address@example.com"}'

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

パラメータ 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
email はい 削除するメール アドレスの名前。


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

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

curl -X DELETE https://api.bitbucket.org/1.0/users/{accountname}/invitations \
  --header "Content-Type: application/json" \
  --data '{"email":"address@example.com","group_slug":"my-group"}'

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

パラメータ 必須かどうか 説明
accountname はい 個人またはチーム アカウントの名前。
group_slug はい グループの識別子。slug は Bitbucket サービスが構成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字に変換して slug を作成します。
email はい 削除するメール アドレスの名前。


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


最終更新日 2019 年 7 月 30 日

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

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