NAME

RT::Client::REST::User -- user object representation.

SYNOPSIS

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

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

RT::Client::REST::User is based on RT::Client::REST::Object. The representation allows to retrieve, edit, comment on, and create users in RT.

Note: RT currently does not allow REST client to search users.

id: For retrieval, you can specify either the numeric ID of the user or his username. After the retrieval, however, this attribute will be set to the numeric id.
name: This is the username of the user.
password: User's password. Reading it will only give you a bunch of stars (what else would you expect?).
priveleged: Can the user have special rights?
email_address: E-mail address of the user, EmailAddress.
real_name: Real name of the user, RealName.
gecos: Gecos.
comments: Comments about this user.
organization
address_one: First line of the street address, Address1.
address_two: Second line of the street address, Address2.
city: City segment of user's address.
zip: ZIP or Postal code segment of user's address.
country: Country segment of user's address.
home_phone: User's home phone number, HomePhone.
work_phone: User's work phone number, WorkPhone.
cell_phone: User's cell phone number, MobilePhone.
pager: User's pager number, PagerPhone.

For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.

Dmitri Tikhonov <dtikhonov@yahoo.com>

Perl license with the exception of RT::Client::REST, which is GPLed.