Skip to main content

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​

Body

required

publicSignupTokenCreateSchema

    name stringrequired

    The token's name.

    expiresAt date-timerequired

    The token's expiration date.

Responses​

The resource was successfully created.

Response Headers

  • location

    string

    The location of the newly created resource.

Schema

    secret stringrequired

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

    Example: a3c84b25409ea8ca1782ef17f94a42fc
    url stringnullablerequired

    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.

    Example: https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc
    name stringrequired

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

    Example: Invite public viewers
    enabled booleanrequired

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

    Example: true
    expiresAt date-timerequired

    The time when the token will expire.

    Example: 2023-04-12T11:13:31.960Z
    createdAt date-timerequired

    When the token was created.

    Example: 2023-04-12T11:13:31.960Z
    createdBy stringnullablerequired

    The creator's email or username

    Example: someone@example.com

    users

    object[]

    nullable

    Array of users that have signed up using the token.

  • Array [

    • id integerrequired

    The user id

    Example: 123
    isAPI booleandeprecated

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

    Example: true
    name stringnullable

    Name of the user

    Example: User
    email string

    Email of the user

    Example: user@example.com
    username stringnullable

    A unique username for the user

    Example: hunter
    imageUrl string

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLink string

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

    Example: http://localhost:4242/invite-link/some-secret
    loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSent boolean

    Is the welcome email sent to the user or not

    Example: false
    rootRole integer

    Which root role this user is assigned

    Example: 1
    seenAt date-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAt date-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountType string

    A user is either an actual User or a Service Account

    Example: User
    permissions string[]

    Deprecated

    scimId stringnullable

    The SCIM ID of the user, only present if managed by SCIM

    Example: 01HTMEXAMPLESCIMID7SWWGHN6

  • ]

    • role

    object

    required

    A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform

    id integerrequired

    The role id

    Example: 9
    type stringrequired

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

    Example: root
    name stringrequired

    The name of the role

    Example: Editor
    description string

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

    Example: 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 stringnullable

    What project the role belongs to

    Example: default
Loading...