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

Request

Responses

usersGroupsBaseSchema

application/json

Schema
Example (from schema)

Schema

groups object[]
A list of user groups and their configuration.
Array [
id integer
The group id
name string required
The name of the group
description string nullable
A custom description of the group
mappingsSSO string[]
A list of SSO groups that should map to this Unleash group
rootRole number nullable
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.
createdBy string nullable
A user who created this group
createdAt date-time nullable
When was this group created
users object[]
A list of users belonging to this group
Array [
joinedAt date-time
The date when the user joined the group
createdBy string nullable
The username of the user who added this user to this group
user objectrequired
An Unleash user
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
]
projects string[]
A list of projects where this group is used
userCount integer
The number of users that belong to this group
]
users object[]
A list of users.
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
]

{
  "groups": [
    {
      "id": 1,
      "name": "unleash-e2e-7095756699593281",
      "userCount": 1,
      "rootRole": null
    }
  ],
  "users": [
    {
      "id": 4,
      "name": "unleash-e2e-user2-7095756699593281",
      "email": "unleash-e2e-user2-7095756699593281@test.com",
      "accountType": "User"
    },
    {
      "id": 1,
      "username": "admin",
      "accountType": "User"
    }
  ]
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema
Example (from 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.

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

Get basic user and group information

Request​

Request