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

VERSION

9       version 0.56
10

SYNOPSIS

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

DESCRIPTION

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

ATTRIBUTES

27       id
28         For retrieval, you can specify either the numeric ID of the user or
29         his username.  After the retrieval, however, this attribute will be
30         set to the numeric id.
31
32       name
33         This is the username of the user.
34
35       password
36         User's password.  Reading it will only give you a bunch of stars
37         (what else would you expect?).
38
39       privileged
40         Can the user have special rights?
41
42       disabled
43         Can this user access RT?
44
45       email_address
46         E-mail address of the user, EmailAddress.
47
48       real_name
49         Real name of the user, RealName.
50
51       gecos
52         Gecos.
53
54       comments
55         Comments about this user.
56
57       nickname
58         Nickname of this user.
59
60       lang
61         Language for this user.
62
63       organization
64       address_one
65         First line of the street address, Address1.
66
67       address_two
68         Second line of the street address, Address2.
69
70       city
71         City segment of user's address.
72
73       zip
74         ZIP or Postal code segment of user's address.
75
76       country
77         Country segment of user's address.
78
79       home_phone
80         User's home phone number, HomePhone.
81
82       work_phone
83         User's work phone number, WorkPhone.
84
85       cell_phone
86         User's cell phone number, MobilePhone.
87
88       pager
89         User's pager number, PagerPhone.
90
91       contactinfo
92         Contact info (Extra Info field).
93
94       signature
95         Signature for the user.
96

DB METHODS

98       For full explanation of these, please see "DB METHODS" in
99       RT::Client::REST::Object documentation.
100
101       retrieve
102         Retrieve RT user from database.
103
104       store
105         Create or update the user.
106
107       search
108         Currently RT does not allow REST clients to search users.
109

INTERNAL METHODS

111       rt_type
112         Returns 'user'.
113

SEE ALSO

115       RT::Client::REST, RT::Client::REST::Object,
116       RT::Client::REST::SearchResult.
117

AUTHORS

119       ·   Abhijit Menon-Sen <ams@wiw.org>
120
121       ·   Dmitri Tikhonov <dtikhonov@yahoo.com>
122
123       ·   Damien "dams" Krotkine <dams@cpan.org>
124
125       ·   Dean Hamstead <dean@bytefoundry.com.au>
126
127       ·   Miquel Ruiz <mruiz@cpan.org>
128
129       ·   JLMARTIN
130
131       ·   SRVSH
132

134       This software is copyright (c) 2018 by Dmitri Tikhonov.
135
136       This is free software; you can redistribute it and/or modify it under
137       the same terms as the Perl 5 programming language system itself.
138
139
140
141perl v5.28.1                      2018-12-24         RT::Client::REST::User(3)
Impressum