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

GET /api/admin/user-admin

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

Request

Responses

• 200
• 401
• 403

---

usersSchema

application/json

Schema

Schema

• users object[]required

  A list of users in the Unleash instance.

  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

  ]
• rootRoles object[]

  A list of root roles in the Unleash instance.

  Array [

  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)

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

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

Loading...