Skip to main content

Get basic user and group information

GET 
/api/admin/user-admin/access

Get a subset of user and group information eligible even for non-admin users

Responses​

usersGroupsBaseSchema

Schema

    groups

    object[]

    A list of user groups and their configuration.

  • Array [

    • id integer

    The group id

    Example: 1
    name stringrequired

    The name of the group

    Example: DX team
    description stringnullable

    A custom description of the group

    Example: Current members of the DX squad
    mappingsSSO string[]

    A list of SSO groups that should map to this Unleash group

    Example: ["SSOGroup1","SSOGroup2"]
    rootRole numbernullable

    A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

    Example: 1
    createdBy stringnullable

    A user who created this group

    Example: admin
    createdAt date-timenullable

    When was this group created

    Example: 2023-06-30T11:41:00.123Z

    users

    object[]

    A list of users belonging to this group

  • Array [

    • joinedAt date-time

    The date when the user joined the group

    Example: 2023-06-30T11:41:00.123Z
    createdBy stringnullable

    The username of the user who added this user to this group

    Example: admin

    user

    object

    required

    An Unleash user

    id integerrequired

    The user id

    Example: 123
    isAPI booleandeprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

    Example: true
    name stringnullable

    Name of the user

    Example: User
    email string

    Email of the user

    Example: user@example.com
    username stringnullable

    A unique username for the user

    Example: hunter
    imageUrl string

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

    Example: http://localhost:4242/invite-link/some-secret
    loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSent boolean

    Is the welcome email sent to the user or not

    Example: false
    rootRole integer

    Which root role this user is assigned

    Example: 1
    seenAt date-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAt date-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountType string

    A user is either an actual User or a Service Account

    Example: User
    permissions string[]

    Deprecated

    scimId stringnullable

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

    Example: 01HTMEXAMPLESCIMID7SWWGHN6

  • ]

    • projects string[]

    A list of projects where this group is used

    Example: ["default","my-project"]
    userCount integer

    The number of users that belong to this group

    Example: 1
    scimId stringnullable

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

    Example: 01HTMEXAMPLESCIMID7SWWGHN7

  • ]

    • users

    object[]

    A list of users.

  • Array [

    • id integerrequired

    The user id

    Example: 123
    isAPI booleandeprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

    Example: true
    name stringnullable

    Name of the user

    Example: User
    email string

    Email of the user

    Example: user@example.com
    username stringnullable

    A unique username for the user

    Example: hunter
    imageUrl string

    URL used for the user profile image

    Example: https://example.com/242x200.png
    inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

    Example: http://localhost:4242/invite-link/some-secret
    loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

    Example: 3
    emailSent boolean

    Is the welcome email sent to the user or not

    Example: false
    rootRole integer

    Which root role this user is assigned

    Example: 1
    seenAt date-timenullable

    The last time this user logged in

    Example: 2023-06-30T11:42:00.345Z
    createdAt date-time

    The user was created at this time

    Example: 2023-06-30T11:41:00.123Z
    accountType string

    A user is either an actual User or a Service Account

    Example: User
    permissions string[]

    Deprecated

    scimId stringnullable

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

    Example: 01HTMEXAMPLESCIMID7SWWGHN6

  • ]

Loading...