User Invitation API
既存のワークスペース（グループ）へユーザを登録するAPI、およびユーザー一覧を取得するAPIについて説明しています。
Overview
- 既存のワークスペース内の指定グループへユーザを追加し、招待します。
- メールを送信するため、あらかじめSendGridサービスの利用が必須です。
Pre-requisites
- Hexabase社へEmail送信用のSendGridのAPI_KEY、テンプレートIDを連絡し、email_template_idの発行を受けます。
- (Optional) Hexabaseデフォルトのメールテンプレートを利用すればemail_template_idの発行をしなくても開発を進めることができます。
API
ユーザー登録
| No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
|---|---|---|---|---|---|---|---|
| 47 | AddUser | ユーザー追加 | POST | /api/v0/users | グループに新規ユーザーを作成 | v0 | - |
| 52 | UserInvite | ユーザー招待 | POST | /api/v0/userinvite | ユーザーへ招待メールを送信する | v0 | - |
| UserImport | ユーザーのインポート | POST | /api/v0/userimport | 指定したグループにユーザーをインポートする | v0 | - | |
| 51 | RemoveUser | ユーザー削除 | DELETE | /api/v0/users | グループからユーザーを削除 | v0 | - |
| ResetUserPassword | パスワード初期化リクエスト（ワークスペース管理者） | POST | /api/v0/users/password/reset | ワークスペース管理者が対象のユーザに対してパスワード変更を依頼します | v0 | - | |
| UpdateUsersInGroupByAdmin | ユーザー情報の更新（ワークスペース管理者、グループ管理者） | POST | /api/v0/groups/:parent-group-id/users | ワークスペース管理者またはグループ管理者がグループ内のユーザー情報を変更します | v0 | - |
Sequence Diagram
WIP
ユーザー一覧の取得
| No | API Name | API名 | Method | URI | 目的 | version | 画面ID(display_id)への対応 |
|---|---|---|---|---|---|---|---|
| GetUsersInGroup | 指定したグループのユーザー一覧の取得 | GET | /api/v0/groups/:group-id/users | 指定したグループのユーザー一覧を取得する | v0 | - | |
| GetUsersInWorkspace | ワークスペースのユーザー一覧の取得 | GET | /api/v0/workspaces/:workspace-id/users | 指定されたワークスペースのユーザー一覧の取得する | v0 | - | |
| GetAllUsersInWorkspace | グループの全ユーザーを取得する | GET | /api/v0/users/all/g/:group-id | グループの全ユーザーを取得する（非推奨） | v0 | - |