Find user groups

GET

/admin/user-group/user-groups

Required scope: viskan:usergroup:read

Searches for user groups.

Parameters

Query parameters

page  integer

The page number to retrieve. The first page is 1. Cannot be less than 1.

Default value: 1

pageSize  integer

The size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.

Default value: 10

keywords  string

Optional keywords (whitespace separated) to search for.

active  enum

Filter by the active status.

Enum: ALLACTIVEINACTIVE

Default value: ACTIVE

Response

The response contains a set of search hits.