| Field Name | Unique? | Validation |
|---|---|---|
| name | ^[a-zA-Z0-9_. ]+$ | |
| ✔ | ^[^@ ]+@[^@ ]+\.[^@ ]+$ | |
| employee_id | ||
| contact_number | ||
| license_number | ||
| license_expiry_month | ||
| license_expiry_year | ||
| license_type | ||
| license_country | ||
| cost-centre_id | ||
| activated-via-company-id |
| Resource | 1-to-1 | 1-to-many | many-to-1 | many-to-many |
|---|---|---|---|---|
| company | ✔ | |||
| cost-centre | ✔ |
Returns a list of users. An accepted query parameter inactive may be set in order to alter the types of users returned.
By default, the returned users are active or pending users from the current company. By including inactive in the query string, returned users changes to inactive, non-pending users for the current company.
The result is returned as a list of { USER HASH } objects.
Creates a new user resource. This endpoint accepts extra list data for perms, license-types, and branch_ids.
Newly created users are put in a pending state until activated.
Once the user hash is created in the datastore, a unique ticket is generated and saved with an expiry time. An email is sent out with the ticket which can then be submitted back to the API via /activate/TICKET.
Updates a user resource.
Note
If password is a submitted field name, it will be removed before updating the user data.
Returns a user’s list of permissions.
Resets a user’s permissions list to the supplied list of permission names.
Only admin and keaz users can add other users to admin and only keaz users can add other users to keaz.
Returns a user’s list of license types.
Sets a user’s list of license types.
Resends a user’s activation email.
Identical to POST /.
Accepts CSV data and creates users from it.