Get a list of groups
GET/api/admin/groups
Get a list of user groups for Role-Based Access Control
Responses
- 200
- 401
- 403
groupsSchema
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
groups
object[]
A list of groups
The group id
1
The name of the group
DX team
A custom description of the group
Current members of the DX squad
A list of SSO groups that should map to this Unleash group
["SSOGroup1","SSOGroup2"]
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.
1
A user who created this group
admin
When was this group created
2023-06-30T11:41:00.123Z
users
object[]
A list of users belonging to this group
The date when the user joined the group
2023-06-30T11:41:00.123Z
The username of the user who added this user to this group
admin
user
object
required
An Unleash user
The user id
123
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
true
Name of the user
User
Email of the user
user@example.com
A unique username for the user
hunter
URL used for the user profile image
https://example.com/242x200.png
If the user is actively inviting other users, this is the link that can be shared with other users
http://localhost:4242/invite-link/some-secret
How many unsuccessful attempts at logging in has the user made
3
Is the welcome email sent to the user or not
false
The last time this user logged in
2023-06-30T11:42:00.345Z
The user was created at this time
2023-06-30T11:41:00.123Z
A user is either an actual User or a Service Account
User
Deprecated
The SCIM ID of the user, only present if managed by SCIM
01HTMEXAMPLESCIMID7SWWGHN6
A list of projects where this group is used
["default","my-project"]
The number of users that belong to this group
1
The SCIM ID of the group, only present if managed by SCIM
01HTMEXAMPLESCIMID7SWWGHN7
{
"groups": [
{
"id": 1,
"name": "DX team",
"description": "Current members of the DX squad",
"mappingsSSO": [
"SSOGroup1",
"SSOGroup2"
],
"rootRole": 1,
"createdBy": "admin",
"createdAt": "2023-06-30T11:41:00.123Z",
"users": [
{
"joinedAt": "2023-06-30T11:41:00.123Z",
"createdBy": "admin",
"user": {
"id": 123,
"name": "User",
"email": "user@example.com",
"username": "hunter",
"imageUrl": "https://example.com/242x200.png",
"inviteLink": "http://localhost:4242/invite-link/some-secret",
"loginAttempts": 3,
"emailSent": false,
"rootRole": 1,
"seenAt": "2023-06-30T11:42:00.345Z",
"createdAt": "2023-06-30T11:41:00.123Z",
"accountType": "User",
"permissions": [
"string"
],
"scimId": "01HTMEXAMPLESCIMID7SWWGHN6"
}
}
],
"projects": [
"default",
"my-project"
],
"userCount": 1,
"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}
]
}
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
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}