Create a new user
POST /api/admin/user-admin
Creates a new user with the given root role.
Request
- application/json
Body
required
createUserSchema
- username string
The user's username. Must be provided if email is not provided.
- email string
The user's email address. Must be provided if username is not provided.
- name string
The user's name (not the user's username).
- password string
Password for the user
rootRole objectrequired
The role to assign to the user. Can be either the role's ID or its unique name.
oneOf- MOD1
- MOD2
integerstringPossible values: [
Admin,Editor,Viewer,Owner,Member]- sendEmail boolean
Whether to send a welcome email with a login link to the user or not. Defaults to
true.
- 201
- 400
- 401
- 403
The resource was successfully created.
Response Headers
location string
The location of the newly created resource.
- application/json
- Schema
- Example (from schema)
Schema
- id integer required
The user id
- isAPI boolean deprecated
(Deprecated): Used internally to know which operations the user should be allowed to perform
- name string nullable
Name of the user
- email string
Email of the user
- username string nullable
A unique username for the user
- imageUrl string
URL used for the userprofile image
- inviteLink string
If the user is actively inviting other users, this is the link that can be shared with other users
- loginAttempts integer
How many unsuccessful attempts at logging in has the user made
- emailSent boolean
Is the welcome email sent to the user or not
rootRole object
Which root role this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.
oneOf- MOD1
- MOD2
integerstringPossible values: [
Admin,Editor,Viewer,Owner,Member]- seenAt date-time nullable
The last time this user logged in
- createdAt date-time
The user was created at this time
- accountType string
A user is either an actual User or a Service Account
- permissions string[]
Deprecated
- scimId string nullable
The SCIM ID of the user, only present if managed by SCIM
{
"id": 123,
"name": "User",
"email": "user@example.com",
"username": "hunter",
"imageUrl": "https://example.com/242x200.png",
"inviteLink": "http://localhost:4242/invite-link/some-secret",
"loginAttempts": 3,
"emailSent": false,
"rootRole": 1,
"seenAt": "2023-06-30T11:42:00.345Z",
"createdAt": "2023-06-30T11:41:00.123Z",
"accountType": "User",
"permissions": [
"string"
],
"scimId": "01HTMEXAMPLESCIMID7SWWGHN6"
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}