mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 09:57:31 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,753 @@
|
||||
---
|
||||
id: flows-bindings-partial-update
|
||||
title: "flows_bindings_partial_update"
|
||||
description: "FlowStageBinding Viewset"
|
||||
sidebar_label: "flows_bindings_partial_update"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWW1z2zYS/isYzs3c3ZxkubbjpP50rqO0nkmajKykvcv5OCAJiqhJgAVA24pG//12F6BIybLkdOq5L/liiyCwu9iXZx+Ai0jXwnAntbrMorMoL/WdjROpMqlmNq65cZKXcVNn3IloEGXCpkbWOB9mv4HZV47PxA9+AfskxZ0VDibCSl4JJ4yNzj4vIonTa+4KeKXgBaqySdw0MoMRmxai4tHZInLzGt9ZZ0AcvMm1qbiDEZq53DTgnH38ePma+elMZkI5mc/xtyukZWgfIwNZsPAAZBrxeyONgO0604jl9SCCGWim33107acI637Q2RytSrVyIBp/8rouZUoOG/1m0YjFQ/N18ptI3X53XQkD3pVfhEGPGQyFk8KSJG5mwj3JJRZFPmmmuOVlA4GMtYrrkqveokTrUsDIps3jsITVGvYNxrGsMd7BwvsXBSkcgQ2kwtoD1GREvFLWrvxD2u4KoUiXDyMEtTbCQjCY0zTeWGFIpTYZ+LHTISFmM/Jsxe9l1VTR2dF3Jy9PXh2fnryEQan84HA1+gqkkOJ5LNRMKhFXOiPPCoUzP0e8LEEeV3NMkk13O+lKHPhAIsYk4R0KALFSwc5kFoPttVZWxDz1W16gzPc5FUmrxQhn5pSoEFrjul/xnXRFTNl473aZcOnVTYK2c1I2RvGY7us+v9Aql7PGCFZANNGlWAZM3Iu0cdowW+imzFjBVVYKxhULe2HtXjASnKUFbATcJg7YZDyd/Ateu8YoSxKFMSCpguzAIIIkWGBlJUtuuoVtRFvNKOhqej6ZsrB921mXG13RUyLAzZh+AxIbVsS/XE5/ii/e/zwd/7pt+V0hYS83QtRtKqeNMZhVwbmQUcteRLmDEs8263fiUQKm4mQLVhvp5hRK3oBQAKMbeLpeEqJ4Z1EVHB0e/p9gpb7ZDxRoLM/eq3LuEbLzwxubsBZLfKGEToF1Usa1MzG8/GoF6OnngDuaGYPX1ststzc9zjybC7341kLfCjelwYtUV5AuITk2da0b/KNwzO+F4URmsYq4Y3eQ4ApynapaM5FJR5m+2veDINwKk2jApu1WbeqdUH0HcX+1bG31HunQfRrDy69X4tft1QXMg8c+Kb9qM9gzjAIFtJY9Jh4xJLZr+cqN4YjZ0onK7q/ZKzCjrkXGMn2nPCbZZ6talP48Zfto/tqyme33+idpZQJALH2L/zh5e+Db9VvoB8AVz14cIpN0GBSY/t/PQz78cj789+Hw+/j6H3+JOojep+mqQD9z3wKmuAaVev4CBelJCyyRM8Ufb8wtqnugRiYAA9rIL+1zaI3to1BGl2WFZTyIGrX2aESqIY0xZzxOpaEP+8U7mjta/boz9ZG2/lqkwIeRQHHXY8PwHxhTxnLsr2+gKYt7XtWlGJBnztc26PMSVgBZBsKcEuciQgYsoFHDnjtAIhIxdgsRhUa7an/k14SnNzOjG7U1yR6iWciFlg90y5msOBKMy5xeYPaheSNwIFjBkKz4Ro88iRXO1f9RgHq0A6xvsJLbobTbUvmZiB8CORiXyBKowUrsPhqsOJbF2lqCpAFkbQqmA4/YeEs7rrm1d8CDWcUVOMpYBkGsdIJkJxO3Mg2JLu5rDWyyMU9AYAyIn08xgbyhtNjmwpLPdeP6boNwpDcCoSNwnbgUues9Gjkr8NlCribctK/bR/96Ty28JbW+DNB6JUW2k18HHkpEWqoGIT4MBctocIfW16TjiayaCnBFogH0VaghX15kL1RMimcnT6XDkWbZP6p+7lfROlStxTNg8gB7xi60DxDd7ul63aVXgljtugEdJ3nYYNfVbrTnbZ3/eoMSRZ4kb2TUtwPrtwPrtwPr0w+s/XL16fUUIHAe+brj0uo8tgkLvVOmx4f1yGDinPypZ9tPKzrFxhiSB9RYATLkUpRZTCGzT6DkLUul7pxt46/whmdwXgK1vPzQ19e7FOhM85Y96o/jP9EfPwoFx4SUnX+4fMQhGSCz3NLXd+62nzdBQC/0QemObfojV6Ezf8ubFnQDjAw+GtGl6qi9Uh4t2nvf5QhzTpjb9o6Y6Eg04rUc3R6PqPDbO5UrdI/fX+9mZbUTZHrtNTKhteBGGDILHTzpbnPHnu32b1ij45y/epGfngxfvPzu5fDkxenRMDnO0+FR+v3pcX56ynN+uiqTJ09/2Lr8qWx7o/HvQkc43I7qAcwfReYAwwTeuaYthgB2PqNmbP30o8Ojk4NXB0cPkuwdv0GUWT/tIPyB5w4CRQKl1GcqSraoEGWp/znTHfGXGi2BXQiwkSrVX/u/u5ziYYhijXGzZ6PRDLpEkxwAwRj1RIy6X0mpkxGoUqO3lxfjn6/GFNtaW1d5UtB+U8BcY22usfD5gm3/fNEryl1fMkKOIciOIJBS4b4CdfY53n44gJNO0Aw/z3rfN7CYCjAWpy4WCdD3j6ZcLnEYMtPglSH8vOVGIu+nYsikxd9QUDkvrdhh+t8moXj/zv7Q55Ct+2shVCGAYrriE/y8EfP+p5vlNcwtgLVh2oLV/vWFt204RSHd8ge4txy0K86B/dZu59zrHsR8OJ9e/ITuDt9nQn0YTscS+Eu2anIWgQaNLeCAomaNr2IvlJC+wRh2TM9jx6D90bsxXPcGBJJmTPWNUBDM1jkOn9Ezy+X/AMF5jgw=
|
||||
sidebar_class_name: "patch 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_bindings_partial_update"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"patch"}
|
||||
path={"/flows/bindings/{fsb_uuid}/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
FlowStageBinding Viewset
|
||||
|
||||
<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"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"path","name":"fsb_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Flow Stage Binding.","required":true}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><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>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"target"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"stage"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"evaluate_on_plan"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies during the Flow planning process."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"re_evaluate_policies"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies when the Stage is present to the user."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"order"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
|
||||
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
|
||||
>
|
||||
|
||||
</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={"invalid_response_action"}
|
||||
required={false}
|
||||
schemaName={"InvalidResponseActionEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`retry`, `restart`, `restart_with_context`]"}
|
||||
schema={{"enum":["retry","restart","restart_with_context"],"type":"string","title":"InvalidResponseActionEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><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={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Fsb 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={"target"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"stage"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
stage_obj
|
||||
</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"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":".5rem","marginBottom":".5rem"}}
|
||||
>
|
||||
|
||||
|
||||
Stage Serializer
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Stage uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"component"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get object type so that we know how to edit the object","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name_plural"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"meta_model_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
flow_set
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object[]
|
||||
</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={"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={{"description":"Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.","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={"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={{"description":"Configure what should happen when a flow denies access to a user.","enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"evaluate_on_plan"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies during the Flow planning process."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"re_evaluate_policies"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies when the Stage is present to the user."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"order"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
|
||||
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
|
||||
>
|
||||
|
||||
</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={"invalid_response_action"}
|
||||
required={false}
|
||||
schemaName={"InvalidResponseActionEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`retry`, `restart`, `restart_with_context`]"}
|
||||
schema={{"enum":["retry","restart","restart_with_context"],"type":"string","title":"InvalidResponseActionEnum"}}
|
||||
>
|
||||
|
||||
</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 \"target\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"stage\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"stage_obj\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"flow_set\": [\n {\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 \"policy_engine_mode\": \"all\",\n \"compatibility_mode\": true,\n \"export_url\": \"string\",\n \"layout\": \"stacked\",\n \"denied_action\": \"message_continue\"\n }\n ]\n },\n \"evaluate_on_plan\": true,\n \"re_evaluate_policies\": true,\n \"order\": 0,\n \"policy_engine_mode\": \"all\",\n \"invalid_response_action\": \"retry\"\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>
|
||||
|
||||
Reference in New Issue
Block a user