Files
authentik/website/docs/developer-docs/api/reference/flows-instances-create.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

564 lines
24 KiB
Plaintext

---
id: flows-instances-create
title: "flows_instances_create"
description: "Flow Viewset"
sidebar_label: "flows_instances_create"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/iuEsLfJVpp2wJanZY1bBEjXIEn7sC4TaOlYZkORGkk5cQ3/951DSrbkyM4KBMWA9SWRRPJcvvOdi7mKdAWGO6HVeR6dRDOp720qlHVcZWDTzAB3EMVRDjYzoqKNuO0NbmMfBdxbcLjoeGGjk0/hdHQbRwb+rsG633S+jE5WUaaVA+XokVeVFJlXmHy2JGwV2WwOJacnt6wAxevpZ8jcsNZrMIJL8QUMrleGzHcCLJ1WvISOFOuMUAXuKoW6AFW4eXTyYh1HVtbFU9t2VX8UVkwlMKGYmwP7cHUxphP8oT3x0xFaw50DQ9v/+jTioy+noz+ORr+ktz/+EKFaJ5x80rxdvddzfa8Yt17rDUkgEzwQFS/AjkkyHhGF4uEIQizl+xmGYxWBqkuKC6/xuHIN7qiSPmgjvrTvQi0Q07x9BWW0lCWFLI5q1Xs1kOkFmCU+IkkKSDG4M1HUgUQU/F3/Gsd9+M62pk7IuPXtrsdnkAn8wu7n3KHXwgZv8X9tIWczbcbsjTYMHnhZSYg9Mqc9B9msOWEgF2gvytEoDxBIxWo16sCBElGsYQuMr7OsXbnzuFYaqbpMMTZCQVrq3IdvA6qUhKRaHvL50ouYeAnvSACKzXSJTBFTIYVbbsQ2EqZaS+DqEfcnihP/emcZnY2REJSlFjHrr94LN0eWWHuvTc5KrjBaxjLEp9S4BVgOC5E1HJJ8qWvX9Q+jm91BHsVt+qYSZq7zakQxp3eL8Zpy0y63r2H5CT5ceLWBCuSyEpCnPNtP5RKsbVjnhKqpNDWfGsv8xwNaz7yO0+wABV83jIZAQjvXtczZHEsXUijwKFDM24usyRBFSyTjnk0e0J2cG3RGaQVRqJbI07THy873Wu1bsTWWP1LZ+YZ4VtoeRL6fLntQuAryciZhAZLpGeu7hMmUs14h8QgELAJACMR6Y1hOHndLVRwKdlOQW+tu+wS5Cp0EBfUkOVMDlXLIaoNc96hukhffbte+C9lKKxuaw/HRi2/Yiqq7oUqPxavkqDuqaxHCyPP3Si6DP33Hmd+zqUJToXIUQhkv08qZFBe/WsM63tMjD3TFb9cHv3e+/0znm2LpL4yu1SDJ+ma/BddygbTR4/Y4EyUiNWbnM79A7CPzEgQQrWDoDT4Z1O+b1dy56k8lXPDA1UahldyOhB2isg+C7RjIjeEUHeGgtE9nx3pApk828dxSM45lBelSh8LTCBBYiQpfOx4D6vdSzfVHcxYm630G/09mFHiotHFpbeS/Y2XY74mJMfIYDkH4ffT5Pvp8g9GnU1P7FSHemYo6NN+MSDhPdIrToaFgM0415XHPXBUGqr7bFLtXR0fPOCZ93PRWNjFGD/xk1yqdCZB5CrT+FXV37atUPjTMEAXzXJBaLi+7+rbjR8e0YNlePF4+Ix5vQeHMmLHTy/M9gOTguBiobwe97U/YXkAn3I3SA26uqZIgm+kGyCeQn+FwmosS33iSzYVQQsQCg2OQ9ensa3GU8Eoki5eJT6V2Jr8mTIJTncl8Yz71ehLmd1FTAW7AeFsI1avtDdIkzDvbG55tVoeh9XGWd5vCdkB8PA0Odc+maQ51wDClt/2i0yZ2qvdQqd4tiqECrmkCnWmPS2P7Fqw4IpzD7uOj41fjn8fHjyj1jt+hq7sFygqCbNw0BrTLt7fSUyuag5T610JvZz6h/R0Adlr8udQB+t35Dc3BPsgUMHuSJAW27Ho6RnySjohk+zSVepqgKpVcnL+e/H498UElXmF/7wj31GIbarHhu8ZO7j26dgxMcvDgkkqiQnKimQ4Cf9srSUK5UYPPlBxzojmur1ZTHEs+GLle02cknaFfk/i44PjrbkohwV+TeADHBuQnkf4OlqFVklmjG7KCtsvah2+3PKzj9sQpNojKHdx728nEy/fXhP60uURt2Gm4H2LwL2ZuHGkPk88y/22F9FRFTUPBSRRkrpuW3J3gQrLF7QN51ZZdtexYiPD4HTf6DhRCFDeuOHpHc1H4P0pTz2I=
sidebar_class_name: "post 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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"flows_instances_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/flows/instances/"}
>
</MethodEndpoint>
Flow Viewset
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3><strong
className={"openapi-schema__required"}
>
required
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"slug"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty` and `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
schema={{"type":"string","minLength":1,"description":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"title"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Shown as the Title in Flow pages."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"designation"}
required={true}
schemaName={"FlowDesignationEnum (string)"}
qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
schema={{"enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"policy_engine_mode"}
required={false}
schemaName={"PolicyEngineMode (string)"}
qualifierMessage={"**Possible values:** [`all`, `any`]"}
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"compatibility_mode"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"layout"}
required={false}
schemaName={"FlowLayoutEnum (string)"}
qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"denied_action"}
required={false}
schemaName={"DeniedActionEnum (string)"}
qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
schema={{"enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication"}
required={false}
schemaName={"AuthenticationEnum (string)"}
qualifierMessage={"**Possible values:** [`none`, `require_authenticated`, `require_unauthenticated`, `require_superuser`, `require_outpost`]"}
schema={{"enum":["none","require_authenticated","require_unauthenticated","require_superuser","require_outpost"],"type":"string","title":"AuthenticationEnum"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"201"}
value={"201"}
>
<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={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Flow uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"policybindingmodel_ptr_id"}
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={"slug"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
schema={{"type":"string","description":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"title"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Shown as the Title in Flow pages."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"designation"}
required={true}
schemaName={"FlowDesignationEnum (string)"}
qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
schema={{"enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"background"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get the URL to the background image. If the name is /static or starts with http\nit is returned as-is","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"stages"}
required={true}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"policies"}
required={true}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"cache_count"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Get count of cached flows","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"policy_engine_mode"}
required={false}
schemaName={"PolicyEngineMode (string)"}
qualifierMessage={"**Possible values:** [`all`, `any`]"}
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"compatibility_mode"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"export_url"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get export URL for flow","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"layout"}
required={false}
schemaName={"FlowLayoutEnum (string)"}
qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"denied_action"}
required={false}
schemaName={"DeniedActionEnum (string)"}
qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
schema={{"enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication"}
required={false}
schemaName={"AuthenticationEnum (string)"}
qualifierMessage={"**Possible values:** [`none`, `require_authenticated`, `require_unauthenticated`, `require_superuser`, `require_outpost`]"}
schema={{"enum":["none","require_authenticated","require_unauthenticated","require_superuser","require_outpost"],"type":"string","title":"AuthenticationEnum"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"policybindingmodel_ptr_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"designation\": \"authentication\",\n \"background\": \"string\",\n \"stages\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"policies\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"cache_count\": 0,\n \"policy_engine_mode\": \"all\",\n \"compatibility_mode\": true,\n \"export_url\": \"string\",\n \"layout\": \"stacked\",\n \"denied_action\": \"message_continue\",\n \"authentication\": \"none\"\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>