logout_user
Force logout a user by removing all their active sessions.
Instructions
Force logout a user by removing all their active sessions.
Each probe opens its own connection, lists the user's sessions and logs the
user out on the node it reached when that node lists a session. Until one
logout has gone through it is sent even when the node lists nothing: it also
sets the user's notBefore in the database, so tokens issued before it are
rejected by every node. Probing goes
on until no session is seen on KEYCLOAK_LOGOUT_CLEAN_PROBES probes in a row
(default 10), at most KEYCLOAK_LOGOUT_MAX_PROBES (default 40), so that nodes
that do not share sessions behind a load balancer are all reached. The
resulting notBefore is reported. The whole run is bounded by
KEYCLOAK_DEADLINE; when it runs out or a request fails, the result says
verification is incomplete, with what was done so far.
Args: username: Exact username (email).
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": {
"username": "<username>"
},
"name": "logout_user"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |