招待一覧
GET
/console/v1/accounts/{accountId}/invitations承諾されていない、有効期限内の招待の一覧を取得します。
認証
Authorizationstring必須Bearer <マネジメントトークン> の形式で指定します。
詳しくは認証を参照してください。
パスパラメーター
accountIdstring必須組織のID。
コンソールのURLの /accounts/ に続く部分です。
レスポンス
viewerobjectマネジメントトークンの発行者の権限。
フィールドを表示フィールドを非表示
canInvitebooleanメンバーを招待できるかどうか。
canCancelboolean招待を削除できるかどうか。
invitationsarray招待の配列。 作成日時の新しい順に並びます。
フィールドを表示フィールドを非表示
invitationIdstring招待のID。
roleobject招待したメンバーに付与するロール。
roleId と effectiveRole を含みます。
invitedEmailstring | null招待先のメールアドレス。
リンクでの招待では null です。
createdAtstring作成日時(ISO 8601)。
expiresAtstring有効期限(ISO 8601)。
エラー
エラーの形式はエラーを参照してください。
| ステータスコード | error | 原因 |
|---|---|---|
401 | console_authentication_failed | マネジメントトークンが正しくない、または有効期限が切れている |
403 | console_authorization_denied | 操作する権限がない |
404 | not_found | リソースが見つからない、またはIDの形式が正しくない |
503 | console_invitations_unavailable | サービスが一時的に利用できない |