Realm Groups

List realm groups

Returns groups defined in the specified realm.

When include_subgroups=true, each top-level group includes its direct child groups in subgroups.

Required scope: realm-groups:read

get/clusters/{cluster_id}/realms/{realm_name}/groups

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm_name}/groups
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
realm_namestring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Query parameters

include_subgroupsboolean

When true, each group includes its direct child groups in subgroups.

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

idstring uuid required
namestring required
pathstring required

Canonical realm group path.

sub_group_countinteger

Number of direct child groups.

Example response

[
  {
    "id": "4f7e3a1b-2c9d-4e5f-8a6b-1c2d3e4f5a6b",
    "name": "engineering",
    "path": "/engineering",
    "sub_group_count": 2
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.