UnrealIRCd User icon

UnrealIRCd User

Manage users on UnrealIRCd server

Kill User

AI-generated

Summary

Force disconnect a user from the UnrealIRCd server by specifying their nickname or UID and providing a reason for the disconnection.

Inputs

  • nick (required) — The nickname or UID of the user to be killed (disconnected forcibly).
  • reason (required) — The reason for killing the user (disconnecting them).
  • redactionOptions — Optional settings to redact sensitive data in the response, including options to redact IP addresses, email addresses, passwords, and custom regex patterns.

Output shape

a single JSON object containing the operation name, success status, and the result details from the kill command.

If the operation succeeds, the response contains success=true and the command result. Errors throw exceptions or return success=false if 'continue on fail' is enabled. Sensitive data in the response can be redacted as configured.

Discussion