Skip to main content

User Invitation API

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

Overview

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

Pre-requisites

  • 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-
52UserInviteユーザー招待POST/api/v0/userinviteユーザーへ招待メールを送信するv0-
UserImportユーザーのインポートPOST/api/v0/userimport指定したグループにユーザーをインポートするv0-
51RemoveUserユーザー削除DELETE/api/v0/usersグループからユーザーを削除v0-

Sequence Diagram

WIP

ユーザー一覧の取得

NoAPI NameAPI名MethodURI目的version画面ID(display_id)への対応
GetAllUsersInWorkspaceグループの全ユーザーを取得するGET/api/v0/users/all/g/:group-idグループの全ユーザーを取得するv0-
GetUsersInGroup指定したグループのユーザー一覧の取得GET/api/v0/groups/:group-id/users指定したグループにユーザーをインポートするv0-
GetUsersInWorkspaceワークスペースのユーザー一覧の取得GET/api/v0/workspaces/:workspace-id/users指定されたワークスペースのユーザー一覧の取得するv0-