UnrealIRCd UserInstall

Summary

List all users currently connected to the UnrealIRCd server, returning user data with configurable redaction and detail level options.

Inputs

• Redaction Options — Configure whether to redact sensitive data such as IP addresses, email addresses, passwords, and custom patterns from the user data returned.
• Object Detail Level — Specify the level of detail for the returned user objects, with values from 0 (lowest detail) to 7 (highest detail). Defaults to 2.

Output shape

a list of user objects reflecting the current users on the server

The user data shape and content is controlled by the 'Object Detail Level' parameter. If redaction is enabled, sensitive fields like IPs, emails, and passwords are masked accordingly. Errors produce failure responses unless 'Continue On Fail' is enabled.

Examples

Example 1: List users showing detailed info but redact sensitive data

Set 'Redact Sensitive Data' to true with IPs, emails, and passwords redacted; set 'Object Detail Level' as 4 or higher to increase detail.