V11 SP8
Loading...

REST API - DELETE User

This operation deletes a user.

Request

Syntax

Send the request using either the ID or the name:

  • ID

    DELETE <webservice>/User/{userId} HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>

  • Name

    DELETE <webservice>/User/byName(userName='{userName}') HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name Description Required
userId The user ID for the user. If the user ID is not known, use the GET User API to retrieve it. Yes-for the request by ID
userName The user name of the user. If the user name is not known, use the GET User API to retrieve it. Yes-for the request by name

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

XML

An .xml file is not needed.

Response

Response Parameters

Parameter Description Element
errorCode The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.
response
errorString The description of the error code. Not all error codes have an error string. response
userId The system-generated ID assigned to the user. entity

Examples

Sample Request

This request uses the ID.

DELETE <webservice>/User/2 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request uses the name.

DELETE <webservice>/User/byName(userName='jsmith') HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_DeleteUserResponse>
  <response errorCode="0" errorString="This user may have created some schedules. Ownership of such schedules is changed to user admin.">
    <entity userId="6"/>
  </response>
</App_DeleteUserResponse>