Skip to main content

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

usersSchema

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

  • scimId string nullable

    The SCIM ID of the user, only present if managed by SCIM

  • ]
  • 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

  • ]
Loading...