Create a public signup token

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the Viewer role

Request

application/json

Body

required

publicSignupTokenCreateSchema

• name string required

  The token's name.

• expiresAt date-time required

  The token's expiration date.

Responses

• 201
• 400
• 401
• 403

---

The resource was successfully created.

Response Headers

• location string

  The location of the newly created resource.

application/json

Schema

Schema

• 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): 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

Example (from schema)

{
  "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,
      "emailSent": false,
      "rootRole": 1,
      "seenAt": "2023-06-30T11:42:00.345Z",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "accountType": "User",
      "permissions": [
        "string"
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN6"
    }
  ],
  "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"
  }
}

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}

curl / cURL

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

python / requests

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

go / native

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

nodejs / axios

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

ruby / Net::HTTP

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

csharp / RestSharp

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

php / cURL

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

java / OkHttp

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'

powershell / RestMethod

curl -L -X POST '<your-unleash-url>/api/admin/invite-link/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "expiresAt": "2024-05-29T08:01:32.362Z"
}'