RT::Client::REST::User(3pm)

1RT::Client::REST::User(U3s)er Contributed Perl DocumentatRiTo:n:Client::REST::User(3)
2
3
4

NAME

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

SYNOPSIS

9         my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
10
11         my $user = RT::Client::REST::User->new(
12           rt  => $rt,
13           id  => $id,
14         )->retrieve;
15

DESCRIPTION

17       RT::Client::REST::User is based on RT::Client::REST::Object.  The
18       representation allows to retrieve, edit, comment on, and create users
19       in RT.
20
21       Note: RT currently does not allow REST client to search users.
22

ATTRIBUTES

24       id
25         For retrieval, you can specify either the numeric ID of the user or
26         his username.  After the retrieval, however, this attribute will be
27         set to the numeric id.
28
29       name
30         This is the username of the user.
31
32       password
33         User's password.  Reading it will only give you a bunch of stars
34         (what else would you expect?).
35
36       email_address
37         E-mail address of the user.
38
39       real_name
40         Real name of the user.
41
42       gecos
43         Gecos.
44
45       comments
46         Comments about this user.
47

DB METHODS

49       For full explanation of these, please see "DB METHODS" in
50       RT::Client::REST::Object documentation.
51
52       retrieve
53         Retrieve RT user from database.
54
55       store
56         Create or update the user.
57
58       search
59         Currently RT does not allow REST clients to search users.
60

INTERNAL METHODS

62       rt_type
63         Returns 'user'.
64

AUTHOR

70       Dmitri Tikhonov <dtikhonov@yahoo.com>
71

LICENSE

73       Perl license with the exception of RT::Client::REST, which is GPLed.
74
75
76
77perl v5.12.0                      2007-12-23         RT::Client::REST::User(3)