Removing User Account
Use the del operation to remove user accounts.
Request Packet Structure
A request XML packet removing user accounts includes the del operation node:
The del node is nested within the UserGetInput type (user.xsd
). This node has the following graphics representation:
-
filter, required
It specifies the filtering rule. Data type: UserSelectionFilterType
(user.xsd
). For more information on filters, refer to the Available Filters section.
Response Packet Structure
The del node of the response packet is structured as follows:
-
result, required
It wraps the result of the requested operation. Data type: extension of resultType (
common.xsd
). -
status, required
It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
-
errcode, optional
Is used to return the error code when the operation fails. Data type: unsignedInt.
-
errtext, optional
It returns an error message if the operation fails. Data type: string.
-
filter-id, optional
It returns a filtering rule specified in the request packet. Data type: anySimple.
-
id, optional
It is required if the operation succeeds. Returns the unique identifier of a removed user account. Data type: integer.
Samples
A request packet can look as follows:
Request: