invitations リソース

Bitbucket Cloud v1 API は廃止予定です

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

限られた 1.0 API リソースの一時的なサポートについて

2.0 REST API では、ユーザーおよびグループ管理は Atlassian Cloud Admin API を使用して行う予定ですが、これらの API エンドポイントはまだ提供されていません。Bitbucket でアトラシアンのプラットフォーム サービスが完全に利用できるようになるまでは、次の 1.0 REST エンドポイントが引き続きサポートされます。

  • /1.0/groups

  • /1.0/group-privileges

  • /1.0/invitations

  • /1.0/users/{accountname}/invitations

概要

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

フィールド

説明

groups

ユーザーが招待された 1 つ以上のアカウント グループ。

invited by

招待元ユーザーのユーザー プロファイル。

utc_sent_on

招待の作成時を示す UTC 値。

email

招待の外部メール

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

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

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

パラメーター

必須

説明

uuid

はい

アカウントの一意の識別子。

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

1 2 3 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"}'

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

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

パラメーター

必須かどうか

説明

accountname

はい

個人またはチーム アカウントの名前。

group_slug

はい

グループの識別子。slug は Bitbucket サービスが作成する識別子です。Bitbucket はスペースをダッシュに変換し、すべてのテキストを小文字にすることで slug を作成します。

email

はい

削除するメール アドレスの名前。

ここをクリックして展開...

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

1 OK

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

1 Not found

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

1 2 3 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 が返されます。

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

1 2 3 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 が返されます。

 

最終更新日 2020年12月 2日)
次でキャッシュ 1:38 AM on Oct 16, 2021 |

その他のヘルプ