Get public signup tokens
GET /api/admin/invite-link/tokens
Retrieves all existing public signup tokens.
Request
- 200
publicSignupTokensSchema
- application/json
- Schema
- Example (from schema)
Schema
tokens object[]required
An array of all the public signup tokens
Array [secret string requiredThe actual value of the token. This is the part that is used by Unleash to create an invite link
url string nullable requiredThe public signup link for the token. Users who follow this link will be taken to a signup page where they can create an Unleash user.
name string requiredThe token's name. Only for displaying in the UI
enabled boolean requiredWhether the token is active. This property will always be
false
for a token that has expired.expiresAt date-time requiredThe time when the token will expire.
createdAt date-time requiredWhen the token was created.
createdBy string nullable requiredThe creator's email or username
users object[]nullable
Array of users that have signed up using the token.
Array [id integer requiredThe user id
isAPI boolean deprecated(Deprecated): Used internally to know which operations the user should be allowed to perform
name string nullableName of the user
email stringEmail of the user
username string nullableA unique username for the user
imageUrl stringURL used for the userprofile image
inviteLink stringIf the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts integerHow many unsuccessful attempts at logging in has the user made
emailSent booleanIs the welcome email sent to the user or not
rootRole integerWhich root role this user is assigned
seenAt date-time nullableThe last time this user logged in
createdAt date-timeThe user was created at this time
accountType stringA user is either an actual User or a Service Account
permissions string[]Deprecated
scimId string nullableThe SCIM ID of the user, only present if managed by SCIM
]role objectrequired
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
id integer requiredThe role id
type string requiredA role can either be a global root role (applies to all projects) or a project role
name string requiredThe name of the role
description stringA more detailed description of the role and what use it's intended for
project string nullableWhat project the role belongs to
]
{
"tokens": [
{
"secret": "a3c84b25409ea8ca1782ef17f94a42fc",
"url": "https://my_unleash_instance/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
"name": "Invite public viewers",
"enabled": false,
"expiresAt": "2023-04-12T11:13:31.960Z",
"createdAt": "2023-04-12T11:13:31.960Z",
"createdBy": "someone",
"users": null,
"role": {
"id": 3,
"type": "root",
"name": "Viewer"
}
}
]
}