Skip to main content

Update a public signup token

PUT 

<your-unleash-url>/api/admin/invite-link/tokens/:token

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

Request

Path Parameters

    token stringrequired

Bodyrequired

publicSignupTokenUpdateSchema

    expiresAtdate-time

    The token's expiration date.

    Example: 2023-04-11T15:46:56Z
    enabledboolean

    Whether the token is active or not.

    Example: true

Responses

publicSignupTokenSchema

Schema
    secretstringrequired

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

    Example: a3c84b25409ea8ca1782ef17f94a42fc
    urlstringnullablerequired

    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
    namestringrequired

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

    Example: Invite public viewers
    enabledbooleanrequired

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

    Example: true
    expiresAtdate-timerequired

    The time when the token will expire.

    Example: 2023-04-12T11:13:31.960Z
    createdAtdate-timerequired

    When the token was created.

    Example: 2023-04-12T11:13:31.960Z
    createdBystringnullablerequired

    The creator's email or username

    Example: someone@example.com
    users object[]nullable

    Array of users that have signed up using the token.

  • Array [
  • idintegerrequired

    The user id

    Example: 123
    isAPIbooleandeprecated

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

    Example: true
    namestringnullable

    Name of the user

    Example: User
    emailstring

    Email of the user

    Example: user@example.com
    usernamestringnullable

    A unique username for the user

    Example: hunter
    imageUrlstring

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLinkstring

    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
    loginAttemptsinteger

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSentboolean

    Is the welcome email sent to the user or not

    Example: false
    rootRoleinteger

    Which root role this user is assigned

    Example: 1
    seenAtdate-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAtdate-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountTypestring

    A user is either an actual User or a Service Account

    Example: User
    permissionsstring[]

    Deprecated

    scimIdstringnullable

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

    Example: 01HTMEXAMPLESCIMID7SWWGHN6
    activeSessionsintegernullable

    Count of active browser sessions for this user

    Example: 2
    deletedSessionsnumber

    Experimental. The number of deleted browser sessions after last login

    Example: 1
  • ]
  • role objectrequired

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

    idintegerrequired

    The role id

    Example: 9
    typestringrequired

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

    Example: root
    namestringrequired

    The name of the role

    Example: Editor
    descriptionstring

    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.
    projectstringnullable

    What project the role belongs to

    Example: default

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L -X PUT '<your-unleash-url>/api/admin/invite-link/tokens/:token' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
"expiresAt": "2023-04-11T15:46:56Z",
"enabled": true
}'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Parameters
— pathrequired
Body required
{
  "expiresAt": "2023-04-11T15:46:56Z",
  "enabled": true
}
ResponseClear

Click the Send API Request button above and see the response here!