2.2. deleteuser

deleteuser is the tool to delete a user in a given context. If you delete a user the public folder entries of this user are transferred to the admin user. All other data are deleted.

2.2.1. Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-i,--userid <integer>Id of the user
-u,--username <string>Username of the user

2.2.2. Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

2.2.3. Return value

0 on success

>0 on failure

2.2.4. Mandatory parameters

contextid {adminuser adminpass} (userid or username)

2.2.5. Command output

On success:

user <userid> in context <contextid> deleted

On failure:

user <userid> in context <contextid> could not be deleted: <reason from server>

2.2.6. Example

root@oxhe~# /opt/open-xchange/deleteuser -c 123 -i 3

user 3 in context 123 deleted