Search Users

POST 
/api/v1/users

Returns users matching the provided search filters. Pass an empty body ({}) to get all users. Requires the VIEW_USER role.

Request

application/json

Body

required

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

• Array [

id string
email stringrequired
username string
firstName string
lastName string
roles string[]
groups string[]

Names of the Keycloak groups the user belongs to

• ]

Example (from schema)

[
  {
    "id": "string",
    "email": "string",
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
      "string"
    ],
    "groups": [
      "string"
    ]
  }
]

Loading...