Package bscw ::
Package api ::
Module ap_rename_user
|
|
Module ap_rename_user
Renames (given) username. See rename_user() for a description.
API definition:
API = (('oname_or_id', 'ASCII string', 1),
('nname', 'ASCII string', 1),
('options', 'struct', 0, [('o_mail', '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,
oname_or_id,
nname,
options={ } )
see above |
|
|
bool
|
rename_user(request,
oname_or_id,
nname,
options={ } )
Renames (given) username. |
|
|
rename_user(request,
oname_or_id,
nname,
options={ } )
|
|
Renames (given) username. The options dictionary may
contain the following key/value parameter(s).
Examples:
>>> s.rename_user(oname_or_id='joe', nname='doe', options={'o_mail': True})
>>> s.rename_user(oname_or_id='123', nname='doe')
- Parameters:
oname_or_id (str) - old user name or ID of user object to be renamed
nname (str) - new user name
options (dict) - dictionary with the following key/value parameter:
-
o_mail (bool) - send email notification
to user
- Returns: bool
-
True
-
raises fault
(10104, 'Bad parameter')
|