Skip to main content

UserInvitation API

既存のワークスペース(グループ)へユーザを招待する

Overview

  • 既存のワークスペース内の指定グループへユーザを追加し、招待するフローと利用APIを説明します。
  • メールを送信するため、あらかじめSendGridサービスの利用が必須です。

Prerequisites

Hexabase社へEmail送信用のSendGridのAPI_KEY、テンプレートIDを連絡し、email_template_idの発行を受けます。 (Optional) Hexabaseデフォルトのメールテンプレートを利用すればemail_template_idの発行をしなくても開発を進めることができます。

API

NoAPI NameAPI名MethodURI目的version画面ID(display_id)への対応
47AddUserユーザー追加POST/api/v0/usersグループに新規ユーザーを作成v0-
51RemoveUserユーザー削除DELETE/api/v0/usersグループからユーザーを削除v0-
52UserInviteユーザー招待POST/api/v0/userinviteユーザーへ招待メールを送信するv0-

Sequence Diagram

WIP