Kick User
AI-generatedSummary
Kick a user from a specified channel on the UnrealIRCd server, providing a required reason for the kick.
Inputs
- Channel (required) — The name of the channel (e.g., #channel) from which to kick the user.
- Nick (required) — The nickname of the user to be kicked from the channel.
- Reason (required) — The reason for kicking the user, which is mandatory.
- Redaction Options — Settings to redact sensitive information from the response, including toggles to redact IP addresses, email addresses, and custom regex patterns when enabled.
Output shape
a single JSON object indicating success and containing the result of the kick operation
The output JSON includes fields: operation (string, always 'kick'), success (boolean), and result (object with details from the server). Errors produce a JSON object with success:false and error message, unless 'Continue On Fail' is enabled to allow workflow continuation.
Examples
Example 1: Kick user 'badUser' from channel '#general' with reason 'Violation of rules'.
Provide channel '#general', nick 'badUser', reason 'Violation of rules'. Optionally enable redaction options to hide sensitive data in response.