Cancel a forced sign-out task. POST /api/openapi/v1/force-logout-tasks/{taskId}/cancellations, scope admin.v1.force-logout-tasks.execute.
- Scope: admin.v1.force-logout-tasks.execute
- Permission: Execute forced sign-out tasks (force-logout-tasks)
- Permission type: Execute
- Endpoint: POST/api/openapi/v1/force-logout-tasks/{taskId}/cancellations
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| taskId | path | string · uuid | Required | Task ID | "<uuid>" |
| Idempotency-Key | header | string | Required | Idempotency key used to prevent duplicate submissions | "<string>" |
| reason | body | string | No | Cancellation reason | "<string>" |
| version | body | integer · int64 | Required | Version used for concurrent update checks | 1 |
Request example
cURL
Responses
204 No Content
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |