Get all Users

GET 
/api/v2/users/search

Search filters and pagination (page/perPage) are passed as query params.

Request

Query Parameters

email string
firstName string
lastName string
username string
exact boolean

When true, filters match exactly instead of partially

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

email stringrequired

username string

firstName string

lastName string

roles string[]

groups string[]

Names of the Keycloak groups the user belongs to

]

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",
      "email": "string",
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "roles": [
        "string"
      ],
      "groups": [
        "string"
      ]
    }
  ],
  "total": 100,
  "page": 1,
  "perPage": 10
}

Loading...