Documentation Center

delete_user

Delete a User.

Description

Removes a user from the application. If the "clean_data" argument is "true()", then the profile and other user information is removed. This cannot be used to remove the current user. The 'admin' and 'guest' users cannot also be removed.

Parameters

action
delete_user
clean_data
If "true()", remove all of the user data associated with this user. Otherwise just remove the login account.
user
User name to delete

Example URL

http://<host>:<port>/<context>/web/user.xql?action=delete_user&clean_data=<value>&user=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available. If SSO is active,or the requested name is the current user, this also returns an error.