Retrieve a token | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/invite-link/tokens/token \
     -H "Authorization: <apiKey>"

{
  "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",
  "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"
  },
  "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",
      "seatType": "Regular",
      "companyRole": "Developer",
      "productUpdatesEmailConsent": false,
      "activeSessions": 2,
      "deletedSessions": 1
    }
  ]
}

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

curl https://app.unleash-instance.example.com/api/admin/invite-link/tokens/token \
     -H "Authorization: <apiKey>"

{
  "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",
  "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"
  },
  "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",
      "seatType": "Regular",
      "companyRole": "Developer",
      "productUpdatesEmailConsent": false,
      "activeSessions": 2,
      "deletedSessions": 1
    }
  ]
}

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

Response

publicSignupTokenSchema

$	curl https://app.unleash-instance.example.com/api/admin/invite-link/tokens/token \
>	-H "Authorization: <apiKey>"

1	{
2	"secret": "a3c84b25409ea8ca1782ef17f94a42fc",
3	"url": "https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
4	"name": "Invite public viewers",
5	"enabled": true,
6	"expiresAt": "2023-04-12T11:13:31.960Z",
7	"createdAt": "2023-04-12T11:13:31.960Z",
8	"createdBy": "someone@example.com",
9	"role": {
10	"id": 9,
11	"type": "root",
12	"name": "Editor",
13	"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.",
14	"project": "default"
15	},
16	"users": [
17	{
18	"id": 123,
19	"name": "User",
20	"email": "user@example.com",
21	"username": "hunter",
22	"imageUrl": "https://example.com/242x200.png",
23	"inviteLink": "http://localhost:4242/invite-link/some-secret",
24	"loginAttempts": 3,
25	"emailSent": false,
26	"rootRole": 1,
27	"seenAt": "2023-06-30T11:42:00.345Z",
28	"createdAt": "2023-06-30T11:41:00.123Z",
29	"accountType": "User",
30	"permissions": [
31	"string"
32	],
33	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
34	"seatType": "Regular",
35	"companyRole": "Developer",
36	"productUpdatesEmailConsent": false,
37	"activeSessions": 2,
38	"deletedSessions": 1
39	}
40	]
41	}

Authentication

Path parameters

Response

Errors

Authentication

Path parameters

Response

Errors