Create a new user
POST<your-unleash-url>/api/admin/user-admin
Creates a new user with the given root role.
Request
- application/json
Bodyrequired
createUserSchema
The user's username. Must be provided if email is not provided.
hunter
The user's email address. Must be provided if username is not provided.
user@example.com
The user's name (not the user's username).
Sam Seawright
Password for the user
k!5As3HquUrQ
rootRole objectrequired
Whether to send a welcome email with a login link to the user or not. Defaults to true
.
false
Responses
- 201
- 400
- 401
- 403
The resource was successfully created.
Response Headers
- application/json
- Schema
- Example (auto)
Schema
The user id
123
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
true
Name of the user
User
Email of the user
user@example.com
A unique username for the user
hunter
URL used for the user profile image
https://example.com/242x200.png
If the user is actively inviting other users, this is the link that can be shared with other users
http://localhost:4242/invite-link/some-secret
How many unsuccessful attempts at logging in has the user made
3
Is the welcome email sent to the user or not
false
rootRole object
The last time this user logged in
2023-06-30T11:42:00.345Z
The user was created at this time
2023-06-30T11:41:00.123Z
A user is either an actual User or a Service Account
User
Deprecated
The SCIM ID of the user, only present if managed by SCIM
01HTMEXAMPLESCIMID7SWWGHN6
Count of active browser sessions for this user
2
Experimental. The number of deleted browser sessions after last login
1
{
"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",
"activeSessions": 2,
"deletedSessions": 1
}
The request data does not match what we expect.
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ValidationError
A description of what went wrong.
The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
{
"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 (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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 (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L '<your-unleash-url>/api/admin/user-admin' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
--data-raw '{
"username": "hunter",
"email": "user@example.com",
"name": "Sam Seawright",
"password": "k!5As3HquUrQ",
"rootRole": 1,
"sendEmail": false
}'