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 stringrequired

application/json

Body

required

createInvitedUserSchema

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

Responses

200

userSchema

application/json

Schema

Schema

id integerrequired
The user id
Example: 123
isAPI booleandeprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
Example: true
name stringnullable
Name of the user
Example: User
email string
Email of the user
Example: user@example.com
username stringnullable
A unique username for the user
Example: hunter
imageUrl string
URL used for the user profile image
Example: https://example.com/242x200.png
inviteLink string
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
loginAttempts integer
How many unsuccessful attempts at logging in has the user made
Example: 3
emailSent boolean
Is the welcome email sent to the user or not
Example: false
rootRole integer
Which root role this user is assigned
Example: 1
seenAt date-timenullable
The last time this user logged in
Example: 2023-06-30T11:42:00.345Z
createdAt date-time
The user was created at this time
Example: 2023-06-30T11:41:00.123Z
accountType string
A user is either an actual User or a Service Account
Example: User
permissions string[]

Deprecated

scimId stringnullable
The SCIM ID of the user, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN6

Example (from schema)

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

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
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 (from schema)

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

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

Example (from schema)

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

Loading...