list_users
List users in a Keycloak realm with optional filters like email, username, or enabled status.
Instructions
List users in the realm, with optional filtering.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"realm": "<realm>"
},
"name": "list_users"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| realm | Yes | Realm name | |
| search | No | Search string for users | |
| No | Email filter | ||
| emailVerified | No | Email verified filter | |
| enabled | No | Enabled filter | |
| exact | No | If true, search is exact match | |
| first | No | Pagination offset | |
| firstName | No | First name filter | |
| idpAlias | No | Identity provider alias filter | |
| idpUserId | No | Identity provider user ID filter | |
| lastName | No | Last name filter | |
| max | No | Maximum results size | |
| q | No | Custom query for searching users | |
| username | No | Username filter | |
| briefRepresentation | No | If true, return brief representation |