UnrealIRCd UserInstall

Summary

Retrieve detailed information about a specific UnrealIRCd user by their nickname or UID, optionally controlling the level of detail and redacting sensitive data fields in the response.

Inputs

• nick (required) — The nickname or UID of the user whose details to fetch.
• objectDetailLevel — An integer from 0 to 7 specifying the level of detail to include in the returned user object.
• redactionOptions — Options to redact sensitive information in the response, including IP addresses, email addresses, passwords, and custom regex patterns.

Output shape

a single record containing the user details with the specified detail level and applied redactions

The returned data structure corresponds to the UnrealIRCd server's user object detail level. If redaction is enabled, sensitive fields such as IPs, emails, and passwords may be obfuscated or removed. Operation success is indicated by a 'success' boolean; failure returns an error message. No pagination is involved as this targets a single user.

Examples

Example 1: Get a user by nick with default detail level and no redaction

nick: 'nickname123', objectDetailLevel: 2, redactionOptions: {}

Example 2: Get a user by UID with maximum detail and redact sensitive data including IPs and emails

nick: 'UID_4567', objectDetailLevel: 7, redactionOptions: { redactSensitiveData: true, redactIPs: true, redactEmails: true, redactPasswords: true }