add_realm_default_group
Assign a default group to a Keycloak realm to automatically apply group settings to new users, simplifying user management and access control configuration.
Instructions
Add a default group to the realm.
Args:
group_id: Group ID to add as default
realm: Target realm (uses default if not specified)
Returns:
Status messageInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | Yes | ||
| realm | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/tools/realm_tools.py:228-243 (handler)The main handler function decorated with @mcp.tool(), which registers and implements the tool logic. It calls the Keycloak API to add a group as a default group for the realm.
@mcp.tool() async def add_realm_default_group( group_id: str, realm: Optional[str] = None ) -> Dict[str, str]: """ Add a default group to the realm. Args: group_id: Group ID to add as default realm: Target realm (uses default if not specified) Returns: Status message """ await client._make_request("PUT", f"/default-groups/{group_id}", realm=realm) return {"status": "added", "message": f"Group {group_id} added as default group"}