Documentation Center

edit_user

Edit a User.

Description

Modify the group membership of an existing user in the database.

Parameters

action
edit_user
user
User name to edit.
groups
A list of the groups that user should belong to. This is either a list, or a comma separated string containing the group names.

Example URL

http://<host>:<port>/<context>/web/user.xql?action=edit_user&user=<value>&groups=<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, this also returns an error.