Update a public signup token

Update information about a specific token. The :token part of the URL should be the token’s secret.

Authentication

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

Path parameters

tokenstringRequired

Request

publicSignupTokenUpdateSchema
expiresAtstringOptionalformat: "date-time"
The token's expiration date.
enabledbooleanOptional
Whether the token is active or not.

Response

publicSignupTokenSchema
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