This operation identifies all the subclients and Virtual Machine clients that are associated with a user and offboards them for the specific user.
Request
Syntax
POST <webservice>/User/Offboard HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
{
"userName": "",
}
or
{
"userId":
}
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 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. |
|
Content-type |
The media type contained in the request body. |
Request Body
|
Parameter |
Description |
Parent Element |
|---|---|---|
|
userName |
The name of the user. You can use the userName parameter or the userId parameter. If the user name is not known, use the GET User API to retrieve it. |
Api_OffboardUserReq |
|
userId |
The system-generated ID assigned to the user. You can use the userName parameter or the userId parameter. If the user ID is not known, use the GET User API to retrieve it. |
Api_OffboardUserReq |
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 |
Examples
Example Request
POST <webservice>/User/Offboard HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
{
"userId":5
}
Example Response
{ "errorMessage":"Successfully offboarded user 5", "errorCode":0
}