Skip to main content

Add a user via a signup token

POST <your-unleash-url>/invite/:token/signup

Authorization

name: Authorizationtype: apiKeyin: header

Create a user with the viewer root role and link them to the provided signup token

Request

Path Parameters

  • token string required

Body

required

createInvitedUserSchema

  • username string

    The user's username. Must be unique if provided.

  • email string required

    The invited user's email address

  • name string required

    The user's name

  • password string required

    The user's password

Responses

userSchema

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 integer

    Which root role this user is assigned

  • 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

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
<your-unleash-url>
apiKey
token — path required
Body required
{
"username": "Hunter",
"email": "hunter@example.com",
"name": "Hunter Burgan",
"password": "hunter2"
}
curl / cURL
curl -L -X POST '<your-unleash-url>/invite/:token/signup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"username": "Hunter",
"email": "hunter@example.com",
"name": "Hunter Burgan",
"password": "hunter2"
}'