UnrealIRCd User icon

UnrealIRCd User

Manage users on UnrealIRCd server

Actions13

Set Nick

AI-generated

Summary

Change a user's nickname on the UnrealIRCd server, optionally forcing the change by disconnecting any user holding the new nickname.

Inputs

  • Nick (required) — The current nickname or UID of the user whose nickname you want to change.
  • New Nick (required) — The new nickname to assign to the user.
  • Force — If true, bypasses nickname uniqueness checks and forcibly disconnects the user holding the new nickname if taken.
  • Redaction Options — Options to redact sensitive information such as IPs, emails, passwords, or custom patterns from the operation's response.

Output shape

a single object indicating success with the result of the nickname change operation

The output JSON includes the operation name, a success boolean, and the result data from the UnrealIRCd server. If 'Force' is enabled, the operation may forcibly disconnect users to enforce the nickname change. Errors will throw exceptions unless 'Continue on Fail' is enabled, in which case error details appear in the output.

Examples

Example 1: Change user nickname from 'OldNick' to 'NewNick' without forcing.

Nick: OldNick, New Nick: NewNick, Force: false

Example 2: Force change user nickname, disconnecting any user currently using the target nickname.

Nick: OldNick, New Nick: NewNick, Force: true

Discussion