Add a user via a signup token | Unleash Documentation

curl -X POST https://app.unleash-instance.example.com/invite/token/signup \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "hunter@example.com",
  "name": "Hunter Burgan",
  "password": "hunter2"
}'

{
  "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
}

Create a user with the viewer root role and link them to the provided signup token

curl -X POST https://app.unleash-instance.example.com/invite/token/signup \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "hunter@example.com",
  "name": "Hunter Burgan",
  "password": "hunter2"
}'

{
  "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
}

Create a user with the viewer root role and link them to the provided signup token

Response

userSchema

$	curl -X POST https://app.unleash-instance.example.com/invite/token/signup \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "hunter@example.com",
>	"name": "Hunter Burgan",
>	"password": "hunter2"
>	}'

1	{
2	"id": 123,
3	"name": "User",
4	"email": "user@example.com",
5	"username": "hunter",
6	"imageUrl": "https://example.com/242x200.png",
7	"inviteLink": "http://localhost:4242/invite-link/some-secret",
8	"loginAttempts": 3,
9	"emailSent": false,
10	"rootRole": 1,
11	"seenAt": "2023-06-30T11:42:00.345Z",
12	"createdAt": "2023-06-30T11:41:00.123Z",
13	"accountType": "User",
14	"permissions": [
15	"string"
16	],
17	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
18	"seatType": "Regular",
19	"companyRole": "Developer",
20	"productUpdatesEmailConsent": false,
21	"activeSessions": 2,
22	"deletedSessions": 1
23	}

Authentication

Path parameters

Request

Response

Errors

Authentication

Path parameters

Request

Response

Errors