softdeleteuser deprecated

PACKAGE: open-xchange-admin

NAME

softdeleteuser - soft-deletes a user in a given context.

SYNOPSIS

softdeleteuser [OPTION]...

DESCRIPTION

This command line tool marks a user as soft-deleted, the leaver state between disabled and deleted: the user cannot log in, is hidden from the address book and from group member lists, cannot be invited to appointments, and the share links and guests the user invited stop working. Mail, files, calendar and contacts are kept, and the login name, mail address and aliases stay reserved. The user can be restored with restoreuser(1) until the retention period configured through com.openexchange.user.softDelete.retentionDays has passed, after which the user is deleted for good. See Soft-deleted users.

The context administrator, guests and shared accounts cannot be soft-deleted.

OPTIONS

-c, --contextid contextid : The context identifier. Mandatory.

-i, --userid userId : Id of the user.

-u, --username username : Username of the user.

-A, --adminuser contextAdmin : Context admin user name for authentication. Optional, depending on your configuration.

-P, --adminpass contextAdminPassword : Context admin password for authentication. Optional, depending on your configuration.

-h, --help : Prints a help text.

--environment : Show info about commandline environment.

--nonl : Remove all newlines (\n) from output.

--responsetimeout : The optional response timeout in seconds when reading data from server (default: 0s; infinite).

EXAMPLES

softdeleteuser -A contextAdmin -P secret -c 1138 -i 137