User Invitation API
This section describes the API for registering users to an existing workspace (group) and the API for retrieving a list of users.
Overview
- Add and invite users to specified groups in existing workspaces.
- In order to send emails, the SendGrid service must be used in advance.
Pre-requisites
- Contact Hexabase with the SendGrid API_KEY and template ID for sending emails and receive an email_template_id.
- (Optional) By using the Hexabase default email template, you can proceed with development without issuing an email_template_id.
API
User registration
| No | API Name | API Name | Method | URI | Purpose | version | Support for display ID(display_id) |
|---|---|---|---|---|---|---|---|
| 47 | AddUser | Add User | POST | /api/v0/users | Create a new user in the group | v0 | - |
| 52 | UserInvite | User invite | POST | /api/v0/userinvite | Send invitation email to users | v0 | - |
| UserImport | Import users | POST | /api/v0/userimport | Import users into specified groups | v0 | - | |
| 51 | RemoveUser | Remove user | DELETE | /api/v0/users | Remove user from group | v0 | - |
| ResetUserPassword | Password initialization request (workspace administrator) | POST | /api/v0/users/password/reset | The workspace administrator will ask the user to change their password. | v0 | - |
Sequence Diagram
WIP
Get user list
| No | API Name | API Name | Method | URI | Purpose | version | Support for display ID(display_id) |
|---|---|---|---|---|---|---|---|
| GetUsersInGroup | Get list of users in specified group | GET | /api/v0/groups/:group-id/users | Get a list of users in the specified group | v0 | - | |
| GetUsersInWorkspace | Get a list of users in a workspace | GET | /api/v0/workspaces/:workspace-id/users | Get a list of users in the specified workspace | v0 | - | |
| GetAllUsersInWorkspace | Get all users in a group | GET | /api/v0/users/all/g/:group-id | Get all users of a group (not recommended) | v0 | - |