user_kick
Close every session a member has open. Unlike user_ban, a kick doesn’t stop the user from reconnecting straight away.
Request
Section titled “Request”{ "cmd": "user_kick", "user": "alice", "reason": "Repeated spam"}| Field | Type | Required | Description |
|---|---|---|---|
user |
string | Yes | Username or user ID. Matching ignores letter case and a leading @. |
reason |
string | No | Shown to the kicked user. Defaults to No reason provided. |
Response
Section titled “Response”{ "cmd": "user_kick", "user": "alice", "kicked": true}Each of the target’s sessions receives an auth_error frame, then closes:
{ "cmd": "auth_error", "val": "Kicked: Repeated spam", "reason": "kicked"}Every other authenticated connection receives the same user_kick frame you got. The kick is recorded in the audit log with its reason.
- The kick succeeds even if the user has no open sessions.
- The user stays a member. Their roles and messages are unchanged.
Permissions
Section titled “Permissions”Requires manage_users. It is blocked while you are timed out.
Errors
Section titled “Errors”val |
When |
|---|---|
User not found |
No account matches user. |
Cannot kick the server owner |
The target has the owner role. |
| Validation message | user is missing, not a string, or blank, or reason is not a string. |
