メンバーの招待
POST
/console/v1/accounts/{accountId}/invitationsメンバーを組織に招待します。 招待の方法は2つあります。
emailを指定すると、招待のメールを送信します。emailを省略すると、レスポンスのinvitationUrlを相手に渡して招待します。
招待の有効期限は7日間です。
認証
Authorizationstring必須Bearer <マネジメントトークン> の形式で指定します。
詳しくは認証を参照してください。
パスパラメーター
accountIdstring必須組織のID。
コンソールのURLの /accounts/ に続く部分です。
リクエストボディ
roleIdstring必須招待するメンバーに付与するロールのID。
メンバー一覧の accountRoles で取得できます。
emailstring招待先のメールアドレス。 省略した場合は、オーナーのロールを指定できません。
レスポンス
invitationobject作成した招待。
フィールドを表示フィールドを非表示
invitationIdstring招待のID。
expiresAtstring有効期限(ISO 8601)。
invitationUrlstring招待を承諾するためのURL。 このレスポンスでのみ取得できます。
エラー
エラーの形式はエラーを参照してください。
| ステータスコード | error | 原因 |
|---|---|---|
400 | bad_request | リクエストボディの形式や値が正しくない |
401 | console_authentication_failed | マネジメントトークンが正しくない、または有効期限が切れている |
403 | console_authorization_denied | 操作する権限がない |
404 | not_found | リソースが見つからない、またはIDの形式が正しくない |
409 | invitation_email_already_member | 指定したメールアドレスのメンバーがすでにいる |
409 | invitation_email_already_invited | 指定したメールアドレスをすでに招待している |
409 | account_member_quota_exceeded | メンバー数の上限に達している |
429 | invitation_email_daily_limit | 1日に送信できる招待メールの上限に達している |
429 | rate_limited | レート制限を超えている |
503 | console_invitations_unavailable | サービスが一時的に利用できない |