Add a user via a signup token
Create a user with the viewer root role and link them to the provided signup token
Authentication
Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format
Path parameters
token
Request
createInvitedUserSchema
email
The invited user's email address
name
The user's name
password
The user's password
username
The user's username. Must be unique if provided.
Response
userSchema
id
The user id
name
Name of the user
email
Email of the user
username
A unique username for the user
imageUrl
URL used for the user profile image
inviteLink
If the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts
How many unsuccessful attempts at logging in has the user made
emailSent
Is the welcome email sent to the user or not
rootRole
Which root role this user is assigned
seenAt
The last time this user logged in
createdAt
The user was created at this time
accountType
A user is either an actual User or a Service Account
Allowed values:
permissions
Deprecated
scimId
The SCIM ID of the user, only present if managed by SCIM
seatType
The seat type of this user
companyRole
The role of the user within the company.
productUpdatesEmailConsent
Whether the user has consented to receive product update emails.
activeSessions
Count of active browser sessions for this user
deletedSessions
Experimental. The number of deleted browser sessions after last login
Errors
400
Bad Request Error
409
Conflict Error
