UnrealIRCd User ToolInstall

Summary

Retrieve detailed information about a specific IRC user on the UnrealIRCd server by their nickname or UID, with configurable detail level and sensitive data redaction options.

Inputs

• nick (required) — The nickname or UID of the IRC user to retrieve information for.
• objectDetailLevel — A number from 0 to 7 indicating the level of detail in the returned user information, where higher values include more details. Defaults to 2.
• redactionOptions — Options to redact sensitive data from the response, including toggles for IP addresses, email addresses, passwords, and custom regex patterns. By default, all sensible information is redacted.

Output shape

A single JSON object containing the IRC user's details at the specified detail level, with sensitive information redacted as configured.

The output includes a 'success' flag, the 'operation' performed ('get'), the raw 'result' object with user details, and an 'ai_safe' flag indicating redaction status. Errors are returned in the same structure if the operation fails.

Examples

Example 1: Retrieve detailed user information with default redaction

Specify the user's nickname and optionally the detail level. The operation returns the user's details excluding sensitive info like IPs and passwords.