RT::Cl...::User(3pm)

💖 RT::Client::REST::User 💖

okay so bestie, we're doing the RT::Client::REST::User page from the User Contributed Perl Documentation, and it's giving "your little handle on a whole human bean in RT." let's GO 🦋

✨ VERSION ✨

version 0.73 — yes ma'am, that's the one.

🌸 SYNOPSIS 🌸

my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});

my $user = RT::Client::REST::User->new(
  rt  => $rt,
  id  => $id,
)->retrieve;

like, that's it. that's the whole vibe. make an RT::Client::REST pointing at your server, hand it to a User with an id, and retrieve that baby. 🫶

---

💅 DESCRIPTION 💅

RT::Client::REST::User is built on top of RT::Client::REST::Object — it inherits the whole energy, no cap.

with this representation you can retrieve, edit, comment on, and create users in RT. four things. all the things you'd want, honestly.

⚠️ heads up bestie: RT currently does not let a REST client search users. so don't come for what RT won't give, okay? 😭

---

⭐ ATTRIBUTES ⭐

each one of these is a little field on the user object. let's run through them like it's a vibe check:

• id — for retrieval you can hand over either the numeric ID of the user or their username. but after retrieval? this attribute gets set to the numeric id, periodt. so don't expect your username back, she's been converted. 💀
• name — this is the username of the user.
• password — the user's password. and omg, if you read it you'll just get a whole bunch of stars back. like, what did you expect?? no peeking, that's the rule. 🌟
• privileged — can the user have special rights? (yes/no, the classic main character question)
• disabled — can this user access RT? (we love a good lockout mechanic 🔒)
• email_address — e-mail address of the user, mapped to EmailAddress.
• real_name — real name of the user, mapped to RealName.
• gecos — Gecos.
• comments — comments about this user.
• nickname — nickname of this user.
• lang — language for this user.
• organization — okay so the original page literally gives this one zero description. no words. a mystery. I'm not gonna make stuff up about it, so just know: it exists. 💜
• address_one — first line of the street address, mapped to Address1.
• address_two — second line of the street address, mapped to Address2.
• city — city segment of the user's address.
• zip — ZIP or Postal code segment of the user's address.
• country — country segment of the user's address.
• home_phone — the user's home phone number, mapped to HomePhone.
• work_phone — the user's work phone number, mapped to WorkPhone.
• cell_phone — the user's cell phone number, mapped to MobilePhone.
• pager — the user's pager number, mapped to PagerPhone. yes, pager. we love a retro icon. 📟
• contactinfo — contact info (the Extra Info field).
• signature — signature for the user.

---

🧚 DB METHODS 🧚

for the full deep dive on these, bestie, go read "DB METHODS" in the RT::Client::REST::Object documentation — that's where the real lore lives.

• retrieve — retrieve the RT user from the database.
• store — create or update the user.
• search — currently RT does not allow REST clients to search users. (again. she said no. 🙈)

---

🔥 INTERNAL METHODS 🔥

• rt_type — returns 'user'. that's it. that's the whole method. iconic behavior honestly. 👑

---

👑 SEE ALSO 👑

• RT::Client::REST
• RT::Client::REST::Object
• RT::Client::REST::SearchResult

---

🌈 AUTHOR 🌈

Dean Hamstead <dean@fragfest.com.au> — thank you for your service, king. 🫡

💖 COPYRIGHT AND LICENSE 💖

this software is copyright (c) 2026, 2020 by Dmitri Tikhonov.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, open source. 🌸

---

and that's the whole page, bestie!! this was perl v5.40.1, dated 2026-04-21, and it's the RT::Cl...::User(3pm) manual page from the User Contributed Perl Documentation. mwah, go retrieve some users. 💋✨