Package bscw ::
Package api ::
Module ap_list_user
|
|
Module ap_list_user
Lists (given) username(s). See list_user() for a description.
API definition:
API = (('options', 'struct', 0, [('o_search', 'ASCII string', 0),
('o_noanon', 'boolean', 0),
('o_locked', 'ASCII string', 0),
('o_access', 'dateTime.iso8601', 0),
('o_create', 'dateTime.iso8601', 0),
('o_before', 'boolean', 0),
('o_lastmod', 'dateTime.iso8601', 0),
('o_attrs', 'array', 0, [('attr', 'ASCII string', 1)])]),
('uname_or_id_list', 'array', 0, [('uname_or_id', 'ASCII string', 1)]))
(c) OrbiTeam Software, 2003-2010, www.bscw.de/copyright.html
|
param_def()
return the parameter definition |
|
|
|
return_def()
return the result definition |
|
|
|
do_it(request,
options={ } ,
uname_or_id_list=[ ] )
see above |
|
|
list
|
list_user(request,
options={ } ,
uname_or_id_list=[ ] )
Lists (given) username(s). |
|
|
|
_user_fltr(user,
options) |
|
|
|
_time_fltr(user,
date,
cmd,
before=True) |
|
|
|
_lock_fltr(user,
flags=None) |
|
|
|
log_api = logging.getLogger('api')
|
|
_get_user_by_name_attrs = { ' LDAP_binding ' : ' ldap_bind ' , ' LDAP_ ...
|
|
__package__ = ' bscw.api '
|
list_user(request,
options={ } ,
uname_or_id_list=[ ] )
|
|
Lists (given) username(s). The returned user list can be altered by
using the options dictionary with the following key/value
parameter(s) or the uname_or_id_list parameter.
Examples:
>>> s.list_user()
>>> s.list_user(options={'o_search': 'u_.*arthur.*'})
>>> s.list_user(
options={'o_attrs': ['__id__', 'addresses']},
uname_or_id_list=['12345', 'paulsen'])
- Parameters:
options (dict) - dictionary with the following key/value parameter(s):
-
o_search (str) - user search expression,
'u_.*' if omitted
-
o_noanon (bool) - omit 'anonymous'
user(s) (default: True )
-
o_attrs (list) - list of user attributes
to be returned, e.g. ['__id__', 'ctime', 'atime',
'addresses', ...] (see get_attributes() for details)
-
o_locked (str) - consider users with
lockflags <f> ::= {a|l|s}
-
a : user locked by administrator
-
l : user locked by LDAP
-
s : user locked by system
-
o_before (bool) - specifies
"before"/"after" search (default:
True )
-
o_access (dateTime) - consider users
with last access
-
before
time , if o_before is
True (default)
-
after
time , if o_before is
False
-
o_create (dateTime) - consider users
with creation time
-
before
time , if o_before is
True (default)
-
after
time , if o_before is
False
-
o_lastmod (dateTime) - consider users
altered after time
uname_or_id_list (list) - list of user name(s) or ID(s) of user objects, if omitted all
users are considered.
- Returns: list
-
list of user attribute dictionaries
-
raises fault
(10104, 'Bad parameter')
|
_get_user_by_name_attrs
- Value:
{ ' LDAP_binding ' : ' ldap_bind ' ,
' LDAP_password ' : ' ldap_passwd ' ,
' additional_text_information ' : ' descr ' ,
' address ' : ' post ' ,
' default_language ' : ' language ' ,
' email_addresses ' : ' addresses ' ,
' home_phone ' : ' homephone ' ,
' homepage ' : ' home_url ' ,
...
|
|