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
- 200
- 401
usersGroupsBaseSchema
- application/json
- Schema
- Example (from schema)
Schema
groups object[]
A list of user groups and their configuration.
Array [id integerThe group id
name string requiredThe name of the group
description string nullableA custom description of the group
mappingsSSO string[]A list of SSO groups that should map to this Unleash group
rootRole number nullableA 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 nullableA user who created this group
createdAt date-time nullableWhen was this group created
users object[]
A list of users belonging to this group
Array [joinedAt date-timeThe date when the user joined the group
createdBy string nullableThe username of the user who added this user to this group
user objectrequired
An Unleash user
id integer requiredThe user id
isAPI boolean deprecatedDeprecated in v5. Used internally to know which operations the user should be allowed to perform
name string nullableName of the user
email stringEmail of the user
username string nullableA unique username for the user
imageUrl stringURL used for the userprofile image
inviteLink stringIf the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts integerHow many unsuccessful attempts at logging in has the user made
emailSent booleanIs the welcome email sent to the user or not
rootRole integerWhich root role this user is assigned
seenAt date-time nullableThe last time this user logged in
createdAt date-timeThe user was created at this time
accountType stringA user is either an actual User or a Service Account
permissions string[]Deprecated
scimId string nullableThe SCIM ID of the user, only present if managed by SCIM
]projects string[]A list of projects where this group is used
userCount integerThe number of users that belong to this group
scimId string nullableThe SCIM ID of the group, only present if managed by SCIM
]users object[]
A list of users.
Array [id integer requiredThe user id
isAPI boolean deprecatedDeprecated in v5. Used internally to know which operations the user should be allowed to perform
name string nullableName of the user
email stringEmail of the user
username string nullableA unique username for the user
imageUrl stringURL used for the userprofile image
inviteLink stringIf the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts integerHow many unsuccessful attempts at logging in has the user made
emailSent booleanIs the welcome email sent to the user or not
rootRole integerWhich root role this user is assigned
seenAt date-time nullableThe last time this user logged in
createdAt date-timeThe user was created at this time
accountType stringA user is either an actual User or a Service Account
permissions string[]Deprecated
scimId string nullableThe SCIM ID of the user, only present if managed by SCIM
]
{
"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."
}