Skip to Content
APIリファレンス招待メンバーの招待

メンバーの招待

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原因
400bad_requestリクエストボディの形式や値が正しくない
401console_authentication_failedマネジメントトークンが正しくない、または有効期限が切れている
403console_authorization_denied操作する権限がない
404not_foundリソースが見つからない、またはIDの形式が正しくない
409invitation_email_already_member指定したメールアドレスのメンバーがすでにいる
409invitation_email_already_invited指定したメールアドレスをすでに招待している
409account_member_quota_exceededメンバー数の上限に達している
429invitation_email_daily_limit1日に送信できる招待メールの上限に達している
429rate_limitedレート制限を超えている
503console_invitations_unavailableサービスが一時的に利用できない