Get a list of groups | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/groups \
     -H "Authorization: <apiKey>"

{
  "groups": [
    {
      "name": "DX team",
      "id": 1,
      "description": "Current members of the DX squad",
      "mappingsSSO": [
        "SSOGroup1",
        "SSOGroup2"
      ],
      "rootRole": 1,
      "createdBy": "admin",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "users": [
        {
          "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",
            "seatType": "Regular",
            "companyRole": "Developer",
            "productUpdatesEmailConsent": false,
            "activeSessions": 2,
            "deletedSessions": 1
          },
          "joinedAt": "2023-06-30T11:41:00.123Z",
          "createdBy": "admin"
        }
      ],
      "projects": [
        "default",
        "my-project"
      ],
      "userCount": 1,
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
    }
  ]
}

Enterprise feature

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

groupsSchema

groupslist of objects

A list of groups

Errors

401

Unauthorized Error

403

Forbidden Error