Get all users and root roles | Unleash Documentation

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

{
  "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
    }
  ],
  "rootRoles": [
    {
      "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"
    }
  ]
}

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

{
  "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
    }
  ],
  "rootRoles": [
    {
      "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"
    }
  ]
}

Will return all users and all available root roles for the Unleash instance.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

usersSchema

userslist of objects

A list of users in the Unleash instance.

rootRoleslist of objects

A list of root roles in the Unleash instance.

Errors

401

Unauthorized Error

403

Forbidden Error

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

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