Package bscw ::
Package api ::
Module ap_chpwd
|
|
Module ap_chpwd
Changes the password of the given username or (un)locks the (given)
username. See chpwd() for a description.
API definition:
API = (('uname_or_id', 'ASCII string', 1),
('passwd', 'ASCII string', 0),
('options', 'struct', 0, [('o_lock', 'boolean', 0),
('o_unlock', 'boolean', 0)]))
(c) OrbiTeam Software, 2007-2010, www.bscw.de/copyright.html
|
param_def()
return the parameter definition |
|
|
|
return_def()
return the result definition |
|
|
|
do_it(request,
uname_or_id,
passwd='
' ,
options={ } )
see above |
|
|
bool
|
chpwd(request,
uname_or_id,
passwd='
' ,
options={ } )
Changes the password of the given username or (un)locks the (given)
username. |
|
|
|
log_api = logging.getLogger('api')
|
|
__package__ = ' bscw.api '
|
chpwd(request,
uname_or_id,
passwd='
' ,
options={ } )
|
|
Changes the password of the given username or (un)locks the (given)
username. Locking is achieved by using the options
dictionary with the following key/value parameter(s).
Examples:
>>> s.chpwd(uname_or_id='joe', passwd='secret')
>>> s.chpwd(uname_or_id='123', passwd='', options={'o_lock': True})
>>> s.chpwd(uname_or_id='joe', passwd='', options={'o_unlock': True})
- Parameters:
uname_or_id (str) - user name or ID of user object
passwd (str) - new password
options (dict) - dictionary with the following key/value parameter(s):
-
o_lock (bool) - lock user
-
o_unlock (bool) - unlock user
- Returns: bool
-
True on success
-
False on success, but insecure password
-
raises fault
(10104, 'Bad parameter')
-
raises fault
(10011, 'Cannot commit request')
|