UnrealIRCd User ToolInstall

Summary

List all IRC users connected to the UnrealIRCd server, optionally specifying the level of detail and redaction of sensitive data in the response.

Inputs

• Redaction Options — Options to redact sensitive data from the response, including IP addresses, email addresses, passwords, and custom regex patterns. By default, all sensitive data redactions are enabled.
• Object Detail Level — A number from 0 to 7 indicating the level of detail included in each user's information. Higher values yield more detailed user information. Defaults to 2.

Output shape

a single JSON object containing a list of all users on the IRC server with details according to the specified detail level, including redactions as configured.

The output JSON includes 'operation' (string), 'success' (boolean), 'result' (user list with detail level and redaction applied), and 'ai_safe' (boolean). The redaction removes sensitive information such as IPs, emails, and passwords by default, but can be customized or disabled via input parameters.

Examples

Example 1: List all users with default detail level and redacted sensitive data

Use default settings with redaction enabled and objectDetailLevel set to 2

Example 2: List all users with full details and no redaction

Set redactionOptions.redactSensitiveData to false and objectDetailLevel to 7