Public signup tokens

Update a public signup token

Changed on

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

put/api/admin/invite-link/tokens/{token}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/invite-link/tokens/{token}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

tokenstring required

Request body

expiresAtstring date-time

The token's expiration date.

enabledboolean

Whether the token is active or not.

Example request

{
  "expiresAt": "2023-04-11T15:46:56Z",
  "enabled": true
}

Response

publicSignupTokenSchema

secretstring required

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

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

namestring required

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

enabledboolean required

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

expiresAtstring date-time required

The time when the token will expire.

createdAtstring date-time required

When the token was created.

createdBystring nullable required

The creator's email or username

Example response

{
  "secret": "a3c84b25409ea8ca1782ef17f94a42fc",
  "url": "https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
  "name": "Invite public viewers",
  "enabled": true,
  "expiresAt": "2023-04-12T11:13:31.960Z",
  "createdAt": "2023-04-12T11:13:31.960Z",
  "createdBy": "someone@example.com",
  "users": [
    {
      "id": 123,
      "name": "User",
      "email": "user@example.com",
      "username": "hunter",
      "imageUrl": "https://example.com/242x200.png",
      "inviteLink": "http://localhost:4242/invite-link/some-secret",
      "loginAttempts": 3,
      "rootRole": 1,
      "seenAt": "2023-06-30T11:42:00.345Z",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "accountType": "User",
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
      "seatType": "Regular",
      "companyRole": "Developer",
      "activeSessions": 2,
      "deletedSessions": 1
    }
  ],
  "role": {
    "id": 9,
    "type": "root",
    "name": "Editor",
    "description": "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": "default"
  }
}

Changes

  • 774670258f04Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 33b1dd229685Revision changes
    • info

      added the optional property // to the response with the status