Update a forced sign-out task. PATCH /api/openapi/v1/force-logout-tasks/{taskId}, 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: PATCH/api/openapi/v1/force-logout-tasks/{taskId}
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>" |
| execution_mode | body | string | Required | Execution timing (immediate or scheduled) | "immediate" |
| prompt | body | string | Required | User message | "<string>" |
| reason | body | string | Required | Task reason | "<string>" |
| scheduled_at | body | string | null · date-time | No | Scheduled execution time | "2026-08-27T10:00:00Z" |
| scope_type | body | string | Required | Logout scope type | "all" |
| subjects | body | array | null | Required | Logout scope | [{"id":"<uuid>","name":"<string>","type":"department"}] |
| target_client | body | string | Required | Target clients for forced logout | "pc" |
| version | body | integer · int64 | Required | Version used for concurrent update checks | 1 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| created_at | string · date-time | Yes | Created at | "2026-08-27T10:00:00Z" |
| created_by | string | null · uuid | No | Creator ID | "<uuid>" |
| created_by_email | string | No | Creator email | "<string>" |
| created_by_name | string | No | Created by | "<string>" |
| executed_at | string | null · date-time | Yes | Executed at | "2026-08-27T10:00:00Z" |
| execution_mode | string | Yes | Execution timing (immediate or scheduled) | "immediate" |
| expires_at | string | null · date-time | Yes | Expires at | "2026-08-27T10:00:00Z" |
| id | string · uuid | Yes | Task ID | "<uuid>" |
| prompt | string | Yes | User message | "<string>" |
| reason | string | Yes | Task reason | "<string>" |
| scheduled_at | string | null · date-time | Yes | Scheduled execution time | "2026-08-27T10:00:00Z" |
| scope_type | string | Yes | Logout scope type | "all" |
| status | string | Yes | Execution status | "pending" |
| subjects | array<OpenapifacadeScopeSubject> | Yes | Logout scope | [{"id":"<uuid>","name":"<string>","type":"department"}] |
| subjects[].id | string · uuid | Yes | Scope subject ID | "<uuid>" |
| subjects[].name | string | Yes | Scope subject name | "<string>" |
| subjects[].type | string | Yes | Object type | "department" |
| target_client | string | Yes | Target clients for forced logout | "pc" |
| updated_at | string · date-time | Yes | Updated at | "2026-08-27T10:00:00Z" |
| updated_by | string | null · uuid | No | Updater ID | "<uuid>" |
| updated_by_email | string | No | Updater email | "<string>" |
| updated_by_name | string | No | Updated by | "<string>" |
| version | integer · int64 | Yes | Version used for concurrent update checks | 0 |
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>" |