Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-28 00:17:12 +01:00
Code Issues Projects Releases Wiki Activity

docs: update description of sendEmail option

Browse Source
This commit is contained in:
Thomas Heartman 2022-03-03 15:24:15 +01:00
parent 5a220caf39
commit 4c4f6a3aaa
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/docs/api/admin/user-admin.md
View File

@ -119,12 +119,12 @@ Creates a new user with the given root role.
**Payload properties**
| Property name | Required | Description | Example value(s) |
|---------------|----------|---------------------------------------------------------------------------------|------------------------|
| `email` | Yes | The user's email address. | `"user@getunleash.io"` |
| `name` | Yes | The user's name | `"Some Name"` |
| `rootRole` | Yes | The role to assign to the user. Can be either the role's ID or its unique name. | `2`, `"Editor"` |
| `sendEmail` | No | Whether to send a registration email to the user or not. Defaults to `true`. | `false` |
| Property name | Required | Description | Example value(s) |
|---------------|----------|-------------------------------------------------------------------------------------------|------------------------|
| `email` | Yes | The user's email address. | `"user@getunleash.io"` |
| `name` | Yes | The user's name | `"Some Name"` |
| `rootRole` | Yes | The role to assign to the user. Can be either the role's ID or its unique name. | `2`, `"Editor"` |
| `sendEmail` | No | Whether to send a welcome email with a login link to the user or not. Defaults to `true`. | `false` |
**Body**