GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  RT::CLIENT::REST::USER (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



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

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



DESCRIPTION

<B>RT::Client::REST::UserB> is based on RT::Client::REST::Object. The representation allows one to retrieve, edit, comment on, and create users in RT.

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

ATTRIBUTES

<B>idB> 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.
<B>nameB> This is the username of the user.
<B>passwordB> User’s password. Reading it will only give you a bunch of stars (what else would you expect?).
<B>privilegedB> Can the user have special rights?
<B>disabledB> Can this user access RT?
<B>email_addressB> E-mail address of the user, EmailAddress.
<B>real_nameB> Real name of the user, RealName.
<B>gecosB> Gecos.
<B>commentsB> Comments about this user.
<B>nicknameB> Nickname of this user.
<B>langB> Language for this user.
<B>organizationB>
<B>address_oneB> First line of the street address, Address1.
<B>address_twoB> Second line of the street address, Address2.
<B>cityB> City segment of user’s address.
<B>zipB> ZIP or Postal code segment of user’s address.
<B>countryB> Country segment of user’s address.
<B>home_phoneB> User’s home phone number, HomePhone.
<B>work_phoneB> User’s work phone number, WorkPhone.
<B>cell_phoneB> User’s cell phone number, MobilePhone.
<B>pagerB> User’s pager number, PagerPhone.
<B>contactinfoB> Contact info (Extra Info field).
<B>signatureB> Signature for the user.

DB METHODS

For full explanation of these, please see <B>DB METHODSB> in RT::Client::REST::Object documentation.
<B>retrieveB> Retrieve RT user from database.
<B>storeB> Create or update the user.
<B>searchB> Currently RT does not allow REST clients to search users.

INTERNAL METHODS

<B>rt_typeB> Returns ’user’.

SEE ALSO

RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::SearchResult.

AUTHOR

Dmitri Tikhonov <dtikhonov@yahoo.com>

LICENSE

Perl license.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 RT::CLIENT::REST::USER (3) 2015-11-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.