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

docs: add "sendEmail" field to user-admin.md (#1329)

Browse Source
This commit is contained in:
Ivar Conradi Østhus 2022-02-08 20:47:01 +01:00 committed by GitHub
parent cc74f1fe8c
commit 609422071f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -123,13 +123,16 @@ Creates a new use with the given root role.
{
"email": "some-email@getunleash.io",
"name": "Some Name",
"rootRole": 2
"rootRole": 2,
"sendEmail": true
}
```
**Notes**
- `rootRole` can either be the role id or the unique name of the role (e.g: `Editor`).
- `email` - Required field.
- `rootRole` - can either be the role id or the unique name of the role (e.g: `Editor`).
- `sendEmail` - set to `true` if you want Unleash to send Welcome email to the new user. Do require the Unleash instance to be configured with email settings.
#### Return values: {#return-values}