terminateRemove
terminateRemove(TerminateRequestDto)
PUT /api/2.0/people/remove/terminate
Terminate the data deletion
Cancels the data deletion queued for the user with the ID specified in the request. The caller needs the permission to edit users. The operation is idempotent and returns no body: it drops the job from the queue, and doing so when nothing is queued, or when the job has already finished, changes nothing and still answers 200. Cancelling does not restore the data the job has already erased, and a cancelled job cannot be resumed - start a new one through POST api/2.0/people/remove/start. To find out whether the job is still running, read GET api/2.0/people/remove/progress/{userId} before and after this call.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| TerminateRequestDto | body | TerminateRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The queued deletion is cancelled, or there was nothing to cancel. No content is returned | - | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no userId | - | - |
| 403 | No permissions to perform this action | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
null (empty response body)
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json