The del-admin-alias operation allows you to delete an additional administrator’s account on your server.

Request Packet Structure

A request contains the del-admin-alias operation node:

<packet>
    <server>
        <del-admin-alias>
            ...
        </del-admin-alias>
    </server>
</packet>

The del-admin-alias node is presented by the complex type AdminAliasDelType (plesk_server.xsd) and structured as follows:

image 75900

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.9.1/agent_input.svg.

  • The filter node is required. It specifies the filtering rule. Data type: AdminAliasFilterType (plesk_server.xsd). This node contains the following nodes:
    • The login node is required. It specifies the login of an additional administrator. Data type: string. This node can be used several times for editing multiple accounts.

Response Packet Structure

The del-admin-alias node of the response packet is structured as follows:

image 75904

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.9.1/agent_output.svg.

  • The result node is required. It wraps the result of the del-admin-alias operation. Data type: resultType (common.xsd). This node contains the following nodes:
    • The status node is required. It returns the execution status of the operation. Data type: result_status. Allowed values: ok | error.
    • The errcode node is required if the operation fails. Returns error code. Data type: unsignedInt.
    • The errtext node is is required if the operation fails. Returns error message. Data type: string.

Samples

Deleting single administrator account

This request deletes an additional administrator account with the login user2:

<packet>
    <server>
        <del-admin-alias>
            <filter>
                <login>user2</login>
            </filter>
        </del-admin-alias>
    </server>
</packet>

Response:

<packet>
    <server>
        <del-admin-alias>
            <result>
                <status>ok</status>
            </result>
        </del-admin-alias>
    </server>
</packet>