Skip to main content

Update a forced sign-out task

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.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

NameLocationTypeRequiredDescriptionExample
taskIdpathstring · uuidRequiredTask ID"<uuid>"
execution_modebodystringRequiredExecution timing (immediate or scheduled)"immediate"
promptbodystringRequiredUser message"<string>"
reasonbodystringRequiredTask reason"<string>"
scheduled_atbodystring | null · date-timeNoScheduled execution time"2026-08-27T10:00:00Z"
scope_typebodystringRequiredLogout scope type"all"
subjectsbodyarray | nullRequiredLogout scope[{"id":"<uuid>","name":"<string>","type":"department"}]
target_clientbodystringRequiredTarget clients for forced logout"pc"
versionbodyinteger · int64RequiredVersion used for concurrent update checks1

Request example

cURL

Responses

200 OK
NameTypeRequiredDescriptionExample
created_atstring · date-timeYesCreated at"2026-08-27T10:00:00Z"
created_bystring | null · uuidNoCreator ID"<uuid>"
created_by_emailstringNoCreator email"<string>"
created_by_namestringNoCreated by"<string>"
executed_atstring | null · date-timeYesExecuted at"2026-08-27T10:00:00Z"
execution_modestringYesExecution timing (immediate or scheduled)"immediate"
expires_atstring | null · date-timeYesExpires at"2026-08-27T10:00:00Z"
idstring · uuidYesTask ID"<uuid>"
promptstringYesUser message"<string>"
reasonstringYesTask reason"<string>"
scheduled_atstring | null · date-timeYesScheduled execution time"2026-08-27T10:00:00Z"
scope_typestringYesLogout scope type"all"
statusstringYesExecution status"pending"
subjectsarray<OpenapifacadeScopeSubject>YesLogout scope[{"id":"<uuid>","name":"<string>","type":"department"}]
subjects[].idstring · uuidYesScope subject ID"<uuid>"
subjects[].namestringYesScope subject name"<string>"
subjects[].typestringYesObject type"department"
target_clientstringYesTarget clients for forced logout"pc"
updated_atstring · date-timeYesUpdated at"2026-08-27T10:00:00Z"
updated_bystring | null · uuidNoUpdater ID"<uuid>"
updated_by_emailstringNoUpdater email"<string>"
updated_by_namestringNoUpdated by"<string>"
versioninteger · int64YesVersion used for concurrent update checks0
Response example
default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example