List forced sign-out tasks. GET /api/openapi/v1/force-logout-tasks, scope admin.v1.force-logout-tasks.read.
- Scope: admin.v1.force-logout-tasks.read
- Permission: Read forced sign-out tasks (force-logout-tasks)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/force-logout-tasks
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 |
|---|---|---|---|---|---|
| keyword | query | string | No | Search keyword | "<string>" |
| status | query | string | No | Execution status | "pending" |
| created_from | query | string · date-time | No | Creation time (from) | "2026-08-27T10:00:00Z" |
| created_to | query | string · date-time | No | Creation time (to) | "2026-08-27T10:00:00Z" |
| page | query | integer · int64 | No | Page number | 1 |
| page_size | query | integer · int64 | No | Page size | 20 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| items | array<OpenapifacadeForceLogoutTaskResponse> | Yes | Records | [{"created_at":"2026-08-27T10:00:00Z","created_by":"<uuid>","created_by_email":"<string>","created_by_name":"<string>","executed_at":"2026-08-27T10:00:00Z","execution_mode":"immediate","expires_at":"2026-08-27T10:00:00Z","id":"<uuid>","prompt":"<string>","reason":"<string>","scheduled_at":"2026-08-27T10:00:00Z","scope_type":"all","status":"pending","subjects":[{"id":"<uuid>","name":"<string>","type":"department"}],"target_client":"pc","updated_at":"2026-08-27T10:00:00Z","updated_by":"<uuid>","updated_by_email":"<string>","updated_by_name":"<string>","version":0}] |
| items[].created_at | string · date-time | Yes | Created at | "2026-08-27T10:00:00Z" |
| items[].created_by | string ｜ null · uuid | No | Creator ID | "<uuid>" |
| items[].created_by_email | string | No | Creator email | "<string>" |
| items[].created_by_name | string | No | Created by | "<string>" |
| items[].executed_at | string ｜ null · date-time | Yes | Executed at | "2026-08-27T10:00:00Z" |
| items[].execution_mode | string | Yes | Execution timing (immediate or scheduled) | "immediate" |
| items[].expires_at | string ｜ null · date-time | Yes | Expires at | "2026-08-27T10:00:00Z" |
| items[].id | string · uuid | Yes | Task ID | "<uuid>" |
| items[].prompt | string | Yes | User message | "<string>" |
| items[].reason | string | Yes | Task reason | "<string>" |
| items[].scheduled_at | string ｜ null · date-time | Yes | Scheduled execution time | "2026-08-27T10:00:00Z" |
| items[].scope_type | string | Yes | Logout scope type | "all" |
| items[].status | string | Yes | Execution status | "pending" |
| items[].subjects | array<OpenapifacadeScopeSubject> | Yes | Logout scope | [{"id":"<uuid>","name":"<string>","type":"department"}] |
| items[].subjects[].id | string · uuid | Yes | Task ID | "<uuid>" |
| items[].subjects[].name | string | Yes | Name | "<string>" |
| items[].subjects[].type | string | Yes | Object type | "department" |
| items[].target_client | string | Yes | Target clients for forced logout | "pc" |
| items[].updated_at | string · date-time | Yes | Updated at | "2026-08-27T10:00:00Z" |
| items[].updated_by | string ｜ null · uuid | No | Updater ID | "<uuid>" |
| items[].updated_by_email | string | No | Updater email | "<string>" |
| items[].updated_by_name | string | No | Updated by | "<string>" |
| items[].version | integer · int64 | Yes | Version used for concurrent update checks | 0 |
| page | integer · int64 | Yes | Page number | 0 |
| page_size | integer · int64 | Yes | Page size | 0 |
| total | integer · int64 | Yes | Total count | 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>" |