查询强制下线任务接口

将 <BASE_URL> 替换为所在企业环境的 API 域名。

  • Scope:admin.v1.force-logout-tasks.read
  • 权限项:强制下线任务读取(force-logout-tasks)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/force-logout-tasks

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。

名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否-"<string>"
statusquerystring否-"pending"
created_fromquerystring · date-time否-"2026-08-27T10:00:00Z"
created_toquerystring · date-time否-"2026-08-27T10:00:00Z"
pagequeryinteger · int64否-1
page_sizequeryinteger · int64否-20

请求示例

cURL

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/force-logout-tasks?keyword=<keyword>&status=<status>&created_from=<created_from>&created_to=<created_to>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray<OpenapifacadeForceLogoutTaskResponse>是-[{"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_atstring · date-time是-"2026-08-27T10:00:00Z"
items[].created_bystring | null · uuid否-"<uuid>"
items[].created_by_emailstring否-"<string>"
items[].created_by_namestring否-"<string>"
items[].executed_atstring | null · date-time是-"2026-08-27T10:00:00Z"
items[].execution_modestring是-"immediate"
items[].expires_atstring | null · date-time是-"2026-08-27T10:00:00Z"
items[].idstring · uuid是-"<uuid>"
items[].promptstring是-"<string>"
items[].reasonstring是-"<string>"
items[].scheduled_atstring | null · date-time是-"2026-08-27T10:00:00Z"
items[].scope_typestring是-"all"
items[].statusstring是-"pending"
items[].subjectsarray<OpenapifacadeScopeSubject>是-[{"id":"<uuid>","name":"<string>","type":"department"}]
items[].subjects[].idstring · uuid是-"<uuid>"
items[].subjects[].namestring是-"<string>"
items[].subjects[].typestring是-"department"
items[].target_clientstring是-"pc"
items[].updated_atstring · date-time是-"2026-08-27T10:00:00Z"
items[].updated_bystring | null · uuid否-"<uuid>"
items[].updated_by_emailstring否-"<string>"
items[].updated_by_namestring否-"<string>"
items[].versioninteger · int64是-0
pageinteger · int64是-0
page_sizeinteger · int64是-0
totalinteger · int64是-0

响应示例

{
  "items": [
    {
      "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
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否-{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring否Request field that failed validation"<string>"
details.reasonstring否Stable validation failure reason"<string>"
details.suggestionstring否Suggested normalized value"<string>"
errorstring是Stable HTTP error type"<string>"

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}