Add a user via a signup token
POST /invite/:token/signup
Create a user with the viewer root role and link them to the provided signup token
Request
Path Parameters
- token string required
- application/json
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
- 200
- 400
- 409
userSchema
- application/json
- Schema
- Example (from schema)
Schema
- id integer required
The user id
- isAPI boolean deprecated
Deprecated in v5. 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 user profile 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
- 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 []."
}
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
- 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": "NameExistsError",
"message": "There is already a feature called \"my-awesome-feature\"."
}