Package bscw :: Package api :: Module ap_remove_user
[hide private]

Module ap_remove_user

Removes (given) username. See remove_user() for a description.

API definition:

API = (('uname_or_id', 'ASCII string', 1),
       ('options', 'struct', 0, [('o_mail', 'boolean', 0),
       ('o_bounced', 'boolean', 0),
       ('o_force', 'boolean', 0),
       ('o_archive', 'boolean', 0),
       ('o_nowner', 'ASCII string', 0),
       ('o_encoding', 'ASCII string', 0),
       ('o_dry_run', 'boolean', 0)]))

(c) OrbiTeam Software, 2007-2010, www.bscw.de/copyright.html


Version: $Rev: 24441 $

Functions [hide private]
 
param_def()
return the parameter definition
 
return_def()
return the result definition
 
do_it(request, uname_or_id='', options={})
see above
 
api_error(m)
bool
remove_user(request, uname_or_id, options={})
Removes (given) username.
 
_logger_occupy(logger=logging.getLogger('api'), prg='')
occupy logger handlers by a stream handler to stdout
 
_logger_restore(logger=logging.getLogger('api'))
restore original handlers of occupied logger
Variables [hide private]
  log_api = logging.getLogger('api')
  verbose = 0
  __package__ = 'bscw.api'
Function Details [hide private]

remove_user(request, uname_or_id, options={})

 

Removes (given) username. The options dictionary may contain the following key/value parameter(s).

Examples:

>>> s.remove_user(uname_or_id='joe')
>>> s.remove_user(uname_or_id='1234',
                  options={'o_force': True, 'o_mail': True})
>>> s.remove_user(uname_or_id='doe',
                  options={'o_archive': True, 'o_dry_run': True})
Parameters:
  • uname_or_id (str) - username or ID of user object to be removed
  • options (dict) - dictionary with the following key/value parameter(s):
    • o_mail (bool) - send email notification
    • o_bounced (bool) - set user address(es) bounced
    • o_force (bool) - force destruction of all owned workspaces
    • o_archive (bool) - archive all deleted documents (on server)
    • o_nowner (str) - set owner of owned workspaces to the 'o_nowner' while archiving
    • o_encoding (str) - change archive file name encodings from UTF-8 to 'o_encoding'
    • o_dry_run (bool) - no changes are committed
Returns: bool
  • True
  • raises fault (10104, 'Bad parameter')
  • raises fault (10011, 'Cannot commit request')