Users

Get all users and [root roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)

Changed on

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

get/api/admin/user-admin

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/user-admin
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

usersSchema

Example response

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

Changes

    • info

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

    • info

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

    • info

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