Skip to main content

Get public signup tokens

GET /api/admin/invite-link/tokens

Retrieves all existing public signup tokens.

Request​

Responses

publicSignupTokensSchema

Schema
  • tokens object[]required

    An array of all the public signup tokens

  • Array [
  • secret string required

    The actual value of the token. This is the part that is used by Unleash to create an invite link

  • url string nullable required

    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.

  • name string required

    The token's name. Only for displaying in the UI

  • enabled boolean required

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

  • expiresAt date-time required

    The time when the token will expire.

  • createdAt date-time required

    When the token was created.

  • createdBy string nullable required

    The creator's email or username

  • users object[]nullable

    Array of users that have signed up using the token.

  • Array [
  • id integer required

    The user id

  • isAPI boolean deprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

  • name string nullable

    Name of the user

  • email string

    Email of the user

  • username string nullable

    A unique username for the user

  • imageUrl string

    URL used for the userprofile image

  • inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

  • loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

  • emailSent boolean

    Is the welcome email sent to the user or not

  • rootRole integer

    Which root role this user is assigned

  • seenAt date-time nullable

    The last time this user logged in

  • createdAt date-time

    The user was created at this time

  • accountType string

    A user is either an actual User or a Service Account

  • permissions string[]

    Deprecated

  • scimId string nullable

    The 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 required

    The role id

  • type string required

    A role can either be a global root role (applies to all projects) or a project role

  • name string required

    The name of the role

  • description string

    A more detailed description of the role and what use it's intended for

  • project string nullable

    What project the role belongs to

  • ]
Loading...