Create a public signup token

Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the Viewer role

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

publicSignupTokenCreateSchema
namestringRequired
The token's name.
expiresAtstringRequiredformat: "date-time"
The token's expiration date.

Response headers

locationstring or null
The location of the newly created resource.

Response

The resource was successfully created.
secretstring
The actual value of the token. This is the part that is used by Unleash to create an invite link
urlstring or null
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.
namestring
The token's name. Only for displaying in the UI
enabledboolean

Whether the token is active. This property will always be false for a token that has expired.

expiresAtstringformat: "date-time"
The time when the token will expire.
createdAtstringformat: "date-time"
When the token was created.
createdBystring or null
The creator's email or username
roleobject
Users who sign up using this token will be given this role.
userslist of objects or null
Array of users that have signed up using the token.

Errors