Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-03-14 00:15:52 +01:00
Code Issues Projects Releases Wiki Activity

docs: Add payload properties for user-admin post payload

Browse Source 
Adds an explanation of what the various properties in the payload
object to the `user-admin` endpoint does. Most seem fairly
self-explanatory, but I'm not entirely sure what `sendEmail` does.

Requires validation by a third party before merging.
This commit is contained in:
Thomas Heartman 2022-02-08 08:04:51 +01:00
parent 1487ae10c6
commit 5a220caf39
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -115,7 +115,17 @@ You can also search for users via the search API. It will preform a simple searc
`POST https://unleash.host.com/api/admin/user-admin`
Creates a new use with the given root role.
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` |
**Body**
@ -128,12 +138,6 @@ Creates a new use with the given root role.
}
```
**Notes**
- `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}
`201: Created`