Create a public signup token
POST/api/admin/invite-link/tokens
Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the Viewer
role
Request
- application/json
Body
required
publicSignupTokenCreateSchema
The token's name.
The token's expiration date.
Responses
- 201
- 400
- 401
- 403
The resource was successfully created.
Response Headers
location
string
The location of the newly created resource.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The actual value of the token. This is the part that is used by Unleash to create an invite link
a3c84b25409ea8ca1782ef17f94a42fc
The 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.
https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc
The token's name. Only for displaying in the UI
Invite public viewers
Whether the token is active. This property will always be false
for a token that has expired.
true
The time when the token will expire.
2023-04-12T11:13:31.960Z
When the token was created.
2023-04-12T11:13:31.960Z
The creator's email or username
someone@example.com
users
object[]
nullable
Array of users that have signed up using the token.
The user id
123
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
true
Name of the user
User
Email of the user
user@example.com
A unique username for the user
hunter
URL used for the user profile image
https://example.com/242x200.png
If the user is actively inviting other users, this is the link that can be shared with other users
http://localhost:4242/invite-link/some-secret
How many unsuccessful attempts at logging in has the user made
3
Is the welcome email sent to the user or not
false
The last time this user logged in
2023-06-30T11:42:00.345Z
The user was created at this time
2023-06-30T11:41:00.123Z
A user is either an actual User or a Service Account
User
Deprecated
The SCIM ID of the user, only present if managed by SCIM
01HTMEXAMPLESCIMID7SWWGHN6
role
object
required
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
The role id
9
A role can either be a global root role (applies to all projects) or a project role
root
The name of the role
Editor
A more detailed description of the role and what use it's intended for
Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.
What project the role belongs to
default
{
"secret": "a3c84b25409ea8ca1782ef17f94a42fc",
"url": "https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
"name": "Invite public viewers",
"enabled": true,
"expiresAt": "2023-04-12T11:13:31.960Z",
"createdAt": "2023-04-12T11:13:31.960Z",
"createdBy": "someone@example.com",
"users": [
{
"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"
}
],
"role": {
"id": 9,
"type": "root",
"name": "Editor",
"description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
"project": "default"
}
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ValidationError
A description of what went wrong.
The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
{
"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 []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}