Get basic user and group information

GET 
<your-unleash-url>/api/admin/user-admin/access

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

Responses

200

usersGroupsBaseSchema

application/json

Schema

Schema

groups object[]
A list of user groups and their configuration.
Array [
idinteger
The group id
Example: 1
namestringrequired
The name of the group
Example: DX team
descriptionstringnullable
A custom description of the group
Example: Current members of the DX squad
mappingsSSOstring[]
A list of SSO groups that should map to this Unleash group
Example: ["SSOGroup1","SSOGroup2"]
rootRolenumbernullable
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
createdBystringnullable
A user who created this group
Example: admin
createdAtdate-timenullable
When was this group created
Example: 2023-06-30T11:41:00.123Z
users object[]
A list of users belonging to this group
Array [
joinedAtdate-time
The date when the user joined the group
Example: 2023-06-30T11:41:00.123Z
createdBystringnullable
The username of the user who added this user to this group
Example: admin
user objectrequired
An Unleash user
idintegerrequired
The user id
Example: 123
isAPIbooleandeprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
Example: true
namestringnullable
Name of the user
Example: User
emailstring
Email of the user
Example: user@example.com
usernamestringnullable
A unique username for the user
Example: hunter
imageUrlstring
URL used for the user profile image
Example: https://example.com/242x200.png
inviteLinkstring
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
loginAttemptsinteger
How many unsuccessful attempts at logging in has the user made
Example: 3
emailSentboolean
Is the welcome email sent to the user or not
Example: false
rootRoleinteger
Which root role this user is assigned
Example: 1
seenAtdate-timenullable
The last time this user logged in
Example: 2023-06-30T11:42:00.345Z
createdAtdate-time
The user was created at this time
Example: 2023-06-30T11:41:00.123Z
accountTypestring
A user is either an actual User or a Service Account
Example: User
permissionsstring[]
Deprecated
scimIdstringnullable
The SCIM ID of the user, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN6
activeSessionsintegernullable
Count of active browser sessions for this user
Example: 2
deletedSessionsnumber
Experimental. The number of deleted browser sessions after last login
Example: 1
]
projectsstring[]
A list of projects where this group is used
Example: ["default","my-project"]
userCountinteger
The number of users that belong to this group
Example: 1
scimIdstringnullable
The SCIM ID of the group, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN7
]
users object[]
A list of users.
Array [
idintegerrequired
The user id
Example: 123
isAPIbooleandeprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
Example: true
namestringnullable
Name of the user
Example: User
emailstring
Email of the user
Example: user@example.com
usernamestringnullable
A unique username for the user
Example: hunter
imageUrlstring
URL used for the user profile image
Example: https://example.com/242x200.png
inviteLinkstring
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
loginAttemptsinteger
How many unsuccessful attempts at logging in has the user made
Example: 3
emailSentboolean
Is the welcome email sent to the user or not
Example: false
rootRoleinteger
Which root role this user is assigned
Example: 1
seenAtdate-timenullable
The last time this user logged in
Example: 2023-06-30T11:42:00.345Z
createdAtdate-time
The user was created at this time
Example: 2023-06-30T11:41:00.123Z
accountTypestring
A user is either an actual User or a Service Account
Example: User
permissionsstring[]
Deprecated
scimIdstringnullable
The SCIM ID of the user, only present if managed by SCIM
Example: 01HTMEXAMPLESCIMID7SWWGHN6
activeSessionsintegernullable
Count of active browser sessions for this user
Example: 2
deletedSessionsnumber
Experimental. The number of deleted browser sessions after last login
Example: 1
]

Example (auto)

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

401

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/user-admin/access' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!