Get all groups in the realm

GET 
/api/v2/users/groups

Supports pagination via page/perPage.

Request

Query Parameters

search string

Filter groups by name

page number

Default value: 1

Page number (1-based)

perPage number

Default value: 10

Items per page

Responses

200

application/json

Schema

Schema

data

object[]

required

The data items for the current page

Array [

id string

name stringrequired

path string

attributes object

realmRoles string[]

Realm roles (incl. composite roles) mapped to this group

subGroups array

]

total numberrequired

The total number of items available

page numberrequired

The current page number

perPage numberrequired

The number of items per page

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "path": "string",
      "attributes": {},
      "realmRoles": [
        "string"
      ],
      "subGroups": [
        null
      ]
    }
  ],
  "total": 100,
  "page": 1,
  "perPage": 10
}

Loading...