Add a user via a signup token

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

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

Request

Path Parameters

token stringrequired

application/json

Bodyrequired

createInvitedUserSchema

usernamestring
The user's username. Must be unique if provided.
Example: Hunter
emailstringrequired
The invited user's email address
Example: hunter@example.com
namestringrequired
The user's name
Example: Hunter Burgan
passwordstringrequired
The user's password
Example: hunter2

Responses

200

userSchema

application/json

Schema

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
rootRoleinteger
Which root role this user is assigned
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

Example (auto)

{
  "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
}

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "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 []."
}

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NameExistsError
messagestring
A description of what went wrong.
Example: There is already a feature called "my-awesome-feature".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

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>/invite/:token/signup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
--data-raw '{
  "username": "Hunter",
  "email": "hunter@example.com",
  "name": "Hunter Burgan",
  "password": "hunter2"
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

token — pathrequired

Body required

{
  "username": "Hunter",
  "email": "hunter@example.com",
  "name": "Hunter Burgan",
  "password": "hunter2"
}

ResponseClear

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