Overview
Deletes a User.
The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|
| token | String | API authentication token | Mandatory |
| userId | Integer | The id of the user we would like to delete. | Mandatory |
Response
Parameters of the API response in DeleteUser type called return:
| Parameter | Type | Description |
|---|
| status | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
|
Examples
Example DeleteUser transaction.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:deleteUser>
<token>7OoPY1HDzqW5mt6ZNH9pUjvjsaG7ZfF7</token>
<userId>3</userId>
</v2:deleteUser>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteUserResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<statusCode>OK</statusCode>
</return>
</ns2:deleteUserResponse>
</S:Body>
</S:Envelope>