list_users

Retrieve and filter users in a Keycloak realm using customizable parameters such as username, email, and enabled status. Supports pagination and default maximum results.

Instructions

List users in the realm.

Args:
    first: Pagination offset
    max: Maximum results size (defaults to 100)
    search: Search string for username, first/last name, or email
    username: Username filter
    email: Email filter
    enabled: Filter by enabled/disabled users
    realm: Target realm (uses default if not specified)

Returns:
    List of user objects

Input Schema

Name	Required	Description	Default
`email`	No
`enabled`	No
`first`	No
`max`	No
`realm`	No
`search`	No
`username`	No

Input Schema (JSON Schema)

{
  "properties": {
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Email"
    },
    "enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Enabled"
    },
    "first": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "First"
    },
    "max": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max"
    },
    "realm": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Realm"
    },
    "search": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Search"
    },
    "username": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Username"
    }
  },
  "title": "list_usersArguments",
  "type": "object"
}

mcp-keycloak

list_users

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from mcp-keycloak

Related Tools

MCP directory API