Skip to main content

Create a new user

POST 

<your-unleash-url>/api/admin/user-admin

Creates a new user with the given root role.

Request

Bodyrequired

createUserSchema

    usernamestring

    The user's username. Must be provided if email is not provided.

    Example: hunter
    emailstring

    The user's email address. Must be provided if username is not provided.

    Example: user@example.com
    namestring

    The user's name (not the user's username).

    Example: Sam Seawright
    passwordstring

    Password for the user

    Example: k!5As3HquUrQ
    rootRole objectrequired

    The role to assign to the user. Can be either the role's ID or its unique name.

    oneOf
    integer
    Example: 1
    sendEmailboolean

    Whether to send a welcome email with a login link to the user or not. Defaults to true.

    Example: false

Responses

The resource was successfully created.

Response Headers
    location

    The location of the newly created resource.

Schema
    idintegerrequired

    The user id

    Example: 123
    isAPIbooleandeprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

    Example: true
    namestringnullable

    Name of the user

    Example: User
    emailstring

    Email of the user

    Example: user@example.com
    usernamestringnullable

    A unique username for the user

    Example: hunter
    imageUrlstring

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLinkstring

    If the user is actively inviting other users, this is the link that can be shared with other users

    Example: http://localhost:4242/invite-link/some-secret
    loginAttemptsinteger

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSentboolean

    Is the welcome email sent to the user or not

    Example: false
    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
    integer
    Example: 1
    seenAtdate-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAtdate-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountTypestring

    A user is either an actual User or a Service Account

    Example: User
    permissionsstring[]

    Deprecated

    scimIdstringnullable

    The SCIM ID of the user, only present if managed by SCIM

    Example: 01HTMEXAMPLESCIMID7SWWGHN6
    activeSessionsintegernullable

    Count of active browser sessions for this user

    Example: 2
    deletedSessionsnumber

    Experimental. The number of deleted browser sessions after last login

    Example: 1

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
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
}'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Body required
{
  "username": "hunter",
  "email": "user@example.com",
  "name": "Sam Seawright",
  "password": "k!5As3HquUrQ",
  "rootRole": 1,
  "sendEmail": false
}
ResponseClear

Click the Send API Request button above and see the response here!