Get a list of groups

GET 
<your-unleash-url>/api/admin/groups

Get a list of user groups for Role-Based Access Control

Responses

200

groupsSchema

application/json

Schema

Schema

groups object[]
A list of groups
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 objectrequired
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
activeSessions integernullable
Count of active browser sessions for this user
Example: 2
deletedSessions number
Experimental. The number of deleted browser sessions after last login
Example: 1
]
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
]

Example (auto)

{
  "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",
            "activeSessions": 2,
            "deletedSessions": 1
          }
        }
      ],
      "projects": [
        "default",
        "my-project"
      ],
      "userCount": 1,
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
    }
  ]
}

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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
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."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

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/groups' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

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!