Saltar al contenido principal
GET
List Groups

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

page
integer<int64>
predeterminado:1

Page number.

Ejemplo:

1

limit
integer<int64>
predeterminado:10

Items per page.

Ejemplo:

10

name
string

Filter by name (case-insensitive substring).

roleId
string

Filter by role ID (relational listing): only groups the role is granted to.

userId
string

Filter by user ID (relational listing): only groups the user belongs to.

Respuesta

OK

items
object[]

The page of groups.

limit
integer<int64>

The page size that was applied.

Ejemplo:

10

page
integer<int64>

The 1-based page this response corresponds to.

Ejemplo:

1

total
integer<int64>

Total number of groups, across all pages.

Ejemplo:

10