Create User
Create a new workspace user.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
Permission required: create-user
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The email address for the user. |
|
| The display name of the user. |
|
| The password for the user. |
|
| The username for the user. |
|
| Whether the user is active, which determines if they can login or not.
By default, the value is |
|
| The bio of the user. |
|
| The nickname of the user. |
|
| The status text of the user. |
|
| The roles the user is assigned on creation. The default value is Note:
Refer to Roles for more information. |
|
| Whether the user should join the default channels when created. The default value is |
|
| Whether the user be required to change their password when they login. The default value is |
|
| Set random password for the user and send by email. If |
|
| Whether the user get a welcome email. The default value is |
|
| Whether the user's email address be verified when created. The default value is |
|
| Any custom fields the user should have on their account. The default value is |
To save customFields
you must first define the customFields
in the admin panel (Administration > Settings > Accounts > Registration > Custom FIelds).
Example Call
Example Response
Change Log
Version | Description |
---|---|
0.48.0 |
|
0.45.0 | Users created via this now join the default channels. |
0.40.0 | Added |
Last updated