Delete user
Delete a user by its user ID.
| Method | DELETE
|
| URL | /v1/user/{siteId}/{userId}
|
Request parameters
All parameters are required.
|
Parameter |
Type |
Description |
|---|---|---|
|
|
string |
String containing change reason. |
|
|
integer |
Site ID. Unique identifier assigned during client-account creation in Nuance Portal. |
|
|
integer |
User ID. |
Response codes
|
Status |
Description |
|---|---|
|
204 |
Request succeeded. There is no content to send in the response. |
|
404 |
The server cannot find the requested user. This user may not exist. |
For a full list of supported response codes for UMAPI, see Response codes.
Samples
Note: Authentication is required to try out samples. For details, see API token authentication.
Sample request
URL: /portal/configuration/api/v1/user/123/12345678?changeReason=SampleDeleteOperation
Sample response
Status Code is 204. Returns no content in the response.
Sample error response (status code 404)
{"error": "HTTP 404 Not Found",
"code": 404
}
