Removing User Account

Use the del operation to remove user accounts.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet removing user accounts includes the del operation node:

<packet version="1.6.3.0">
<user>
   <del>
   ...
   </del>
</user>
</packet>

 

The del node is nested within the UserGetInput type (user.xsd). This node has the following graphics representation:

user-del-rps.gif

  • 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:

user-set-reps.gif

  • 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:

<packet version="1.6.3.0">
<user>
<del>
   <filter>
      <guid>8712cd03-14e2-9e16-95af-c67e3ffc2696</guid>
   </filter>
</del>
</user>
</packet>

Request:

<packet version="1.6.3.0">
  <user>
    <del>
      <result>
        <status>ok</status>
        <filter-id>8712cd03-14e2-9e16-95af-c67e3ffc2696</filter-id>
        <id>21</id>
      </result>
    </del>
  </user>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.