Files
authentik/website/docs/developer-docs/api/reference/events-system-tasks-list.api.mdx
2024-09-13 12:17:54 -05:00

741 lines
32 KiB
Plaintext

---
id: events-system-tasks-list
title: "events_system_tasks_list"
description: "Read-only view set that returns all background tasks"
sidebar_label: "events_system_tasks_list"
hide_title: true
hide_table_of_contents: true
api: eJytV01v2zgQ/SuEzmqUTXtY5LRBNwgCpN2gSXcPhWHQ0thiTZMqP5J4Df/3nSEli7ZlN872ZNEkZ94M3zxyVpluwHAntLqtsssMnkA5O7ZL62AxdtzO7VgK67I8q8CWRjS0FBd+AV6900ou2ZOAZ2bBMVdzxww4b5RlXEo24eV8ZrRXFQuW0EjDDV+AA2Ozy2+rTJCpHx7MEucUzuAw/OSZLWtY8OxylbllQ/9bZ4SaZet1vuqWalNB+DPPDPzwwgDGMOXSQr5tehv7P7UoazYVIBGYZt4Ce65Bsc4cRgIYiPXS2bNXQmn4DE6EccVoE1N+MQHDnoWrhQqu8W+huIOqBUHZHcQhlIMZmD0gYyv+PRXN5whDT7vIKTXxNBlSJGB9NQgL3JT1yfmI2xjSY/HTvA9RxzruvD2yM88A043Uy8AYbWilL0uwduolDryaK/2s8OuZG0UbRgd9eVEdhTjKM8dnNvgKRZXhPxZKb4RbBvJzj4etnJjjaETrMfGNVhYs2bs4P6efUmN6laNP3jRSlKFWi++WUrba968n36Gkcm0MVbYT0VpLKRF3HV+r4MUlqyI/szUtgyehvR2cLLHOh7dhyAYOzDntuBwTt4at4okaNxaqgpfBeVDVwdl1Sr9vMawkiA5yD3Abzrbz1BUdrXCSfN33eQ3uQuUkWLgxnEgjUE7tUOq3S+AB9YdLLF72iIJ5q6aacVRPGnwJtvcOyxMPB3g+1WbBHfE0EtWgXv+Fcp1dOuNh3dF4j7e400s5Hp7dhXuDqk/LGS0PCsa+3v455G0Q5XrH3sB8PAInFoBfi+ZopBVK5jtaOgRgKpSw9a+wVHmzW0gt41IL2k/k4PZWo3BzJ0W96myJUSdBeatVxLodwB0LH8J1TSx5CNavyTL6wljtTmmdSkh0JIFJPWOtsXjMdL0HaXpxNDmD6myPmqfmGgGjqbFEuZRpfhCOQ92jnMBLCRFavlFwytNWugSWTQhk4mmotMP781j67vTsjpx2aQsBmUE+BikfnOEOPyfewWBWeVUJws3lfZqj9a5IJVY6Z2lWNtjyJLujrUiuwyayCy8NmrWvZrrCSubE2o6qwQBt6C1MtJbA1Z64pqxJSmSg7lKBSRiab959OxWf97d6kLLREO2zvUQmF16vy/vCDVVv5I7eucHQdg3Q6X74n7fxtsW/UeOrsJVdtyzeuYK1Gof36Tiw/DUF3L+NEGU1JO3rwzTs89JDi8gO5uP9L8zHDSi8+Ep2dX97ICEVOC7kYOEdjnaboMFAwoDW6ZEwg4K6WlNjNINw93JX46CIL7oibZMKYiqYp6618UbSSt6I4ul9ka2T198DpSXGlbwBNxHUzjXd0zLUHL6K2/dMkLYgrTGGfnuekeeI/OL84sPZ72e/7eX5E59Te9PtiqfFrFg0Mrzt6Th5GY4Tz43yndUgpf5jpjeezoQOGilKwKdqIGt8EH+6faQaDWFTCPayKGZ4V/jJWakXRWKi6L8mUk8KdKWKu9uP158frkOYjbZuwVViPCacxYTHbpIN9aUJJd/aoranQFdb0UiERuGGsFbt+W9e9HhICQNwSPyqETytWa0m3MJXI9dr+ju2D8SMSliS2b4nmsOy73ufuPQQq2xg6cFgT+1pB6OMQJKu+o1gTu5sj6BpG+s3InltV/sTAF1D/eZ87HS2R9xtWufjvtrF3dX4msWxEehXjmiA/Ua48rEDRepixdDDB0kat1yV9N5Kdu2pPFnZiOTNNUkAVXf6ZIjylXcfZL27y9QysY0FE1Y86jkoLJoOt6MxOkKN/g9EbHS9
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"events_system_tasks_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/events/system_tasks/"}
>
</MethodEndpoint>
Read-only view set that returns all background tasks
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"name","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"status","schema":{"type":"string","enum":["error","successful","unknown","warning"]}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"uid","schema":{"type":"string"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
pagination
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"next"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"previous"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"count"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"current"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"total_pages"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"start_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"end_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
results
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"uuid"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"full_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get full name with UID","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"uid"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"description"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"start_timestamp"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"finish_timestamp"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"duration"}
required={true}
schemaName={"double"}
qualifierMessage={undefined}
schema={{"type":"number","format":"double","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={true}
schemaName={"SystemTaskStatusEnum (string)"}
qualifierMessage={"**Possible values:** [`unknown`, `successful`, `warning`, `error`]"}
schema={{"enum":["unknown","successful","warning","error"],"type":"string","title":"SystemTaskStatusEnum"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
messages
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"timestamp"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"log_level"}
required={true}
schemaName={"LogLevelEnum (string)"}
qualifierMessage={"**Possible values:** [`critical`, `exception`, `error`, `warn`, `warning`, `info`, `debug`, `notset`]"}
schema={{"enum":["critical","exception","error","warn","warning","info","debug","notset"],"type":"string","title":"LogLevelEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"logger"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"event"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
attributes
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","additionalProperties":{}}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</div>
</details>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"expires"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"expiring"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pagination\": {\n \"next\": 0,\n \"previous\": 0,\n \"count\": 0,\n \"current\": 0,\n \"total_pages\": 0,\n \"start_index\": 0,\n \"end_index\": 0\n },\n \"results\": [\n {\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"full_name\": \"string\",\n \"uid\": \"string\",\n \"description\": \"string\",\n \"start_timestamp\": \"2024-09-13T14:05:42.181Z\",\n \"finish_timestamp\": \"2024-09-13T14:05:42.181Z\",\n \"duration\": 0,\n \"status\": \"unknown\",\n \"messages\": [\n {\n \"timestamp\": \"2024-09-13T14:05:42.181Z\",\n \"log_level\": \"critical\",\n \"logger\": \"string\",\n \"event\": \"string\",\n \"attributes\": {}\n }\n ],\n \"expires\": \"2024-09-13T14:05:42.181Z\",\n \"expiring\": true\n }\n ]\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"non_field_errors"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"non_field_errors\": [\n \"string\"\n ],\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"403"}
value={"403"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"detail"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"detail\": \"string\",\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>