Delete a User

Note: This query is not available to Policy servers in NW-CMP mode.

The following examples show the requests and responses that are defined in the XSD files for the DeleteSysAdminUser tag.

Request

This request follows the DeleteSysAdminUser tag defined in the XSD files.
<XmlInterfaceRequest>
  <DeleteSysAdminUser>
    <SysAdminUser>
      <Name>admin1</Name>
    </SysAdminUser>
  </DeleteSysAdminUser>
</XmlInterfaceRequest>
The DeleteSysAdminUser operation parameters are as follows:
  • Name (Required):

    250 characters (string); can only contain the characters A–Z, a–z, 0–9, period (.), hyphen (-), and underline (_).

The probable DeleteSysAdminUser errors a user may receive are as follows:
  • ERROR_DELETE_FAILURE:

    Error deleting User Name: {$UserName}.

    The specified user does not exist, or Admin user is specified.

If deletion is successful, the number of deleted users will be reported.

Response

The response to this request:
<Response>
<Result>0</Result>
<Command type="XmlInterfaceResponse">
<Success count="1">Deleted 1 users.</Success>
<Failure count="0"></Failure>
</Command>
</Response>

ERROR_DELETE_FAILURE Request

This request follows the DeleteSysAdminUser tag defined in the XSD files.

<XmlInterfaceRequest>
  <DeleteSysAdminUser>
    <SysAdminUser>
      <Name>admin1</Name>
    </SysAdminUser>
  </DeleteSysAdminUser>
</XmlInterfaceRequest>

ERROR_DELETE_FAILURE Response

The response to this request when the specified user name does not exist:

<Response>
<Result>0</Result>
<Command type="XmlInterfaceResponse">
<Success count="0"></Success>
<Failure count="1">Failed to delete 1 user.  
Error deleting User Name: admin1</Failure>
</Command>
</Response>