eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 17:45:21 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
7a6d44d0dfd3a144df03f734283531f69abdebc6
authentik/website/docs/developer-docs/api/reference/policies-dummy-partial-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

503 lines
18 KiB
Plaintext
Raw Blame History

---
id: policies-dummy-partial-update
title: "policies_dummy_partial_update"
description: "Dummy Viewset"
sidebar_label: "policies_dummy_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJzVV1tv2zYU/iuEXrYBrpUmwRr4aWkadAHaLcileygMgZKOLdYUqZFUbM/Qf985pGXJsZIgWIGhD3Eo8ly/c+HhJtIVGO6EVld5NIkqLUUmwCZ5XZbrpOLGCS6Tusq5g2gU5WAzIyqiR+oPRMS+CFhacHiK5LwEB8ZGk6+bSBBNxV2BRwoPWvnrpK5Fjps2K6Dk0WQTuXVFx9YZoeZ4MtOm5A53PGXzWPE5u7+/+sACORM5KCdma1q7QlgW7Lr2usYozcDftTCADjpTQzMdRY7Pycadv9E0UIF173W+JpMyrRzKpSWvKiTzKMXfLFmwObRdp98gc09gFGxht2AQTvEPGELLEPaOtKOUANAhEqVQn0DNEcTJW8QBVpDVJDqRej4nko4n1VoCVwcm/FWACsBov8VwBYqnEvIR41KynVCkmAXKECi2FHicAiNlkI/Z+zXLYcZr6UZMK7nuWBkYo41l3OyoKW4GLBIPGIlnSy5cUgrVOxWI+dyjU/KVKOsymhy/PX13enby6+k7D0bYfLPbPdsJ4qv/KAglOeEksV9zh/HNffBC7G5CdkRNQ3QWvTbCrX2e89oVlIEL/Jo2PpNshWCGwB4fHf0P6VQtXi4rMpTnf2IYQ2H03A/y2+Ibzs0fMBszXWJgtmF4DM6+mR/BsRADtuNiVqM93LElsIXSS1bgn9MMcuHwANguaPvAouYHMKm2kDxV5vvKb8DVRm3F/WTZHvcL0pNK1obL1ysJfC/qwgbPk1LnIF/nDFWkUajA87KnxKe6Vnni9GAtP+PALkkwXbwMDMyQ/B+sIXVX19cOmn4iHwZkW68j6gGPEm84U6Zd4fcaXuQb3T7iBNLpd+1nX7B/5Z6VXVLJHt6L2FxmAmSehJLuieTG8DUyCAelHehPvuDzoc6FJzzHokW1XF739fXugM60YNmTeJx8Rzw+gsKmnrHz66snAMkx3GKgvJ/1tp9GWwG9qG+VPuNmqPtC52Giywo/7dFQEsXtDBX7mTHe9Ga8JqYpD8xDOxLWRhILr0T8cBJHdFm2V+ktIRRc7F2oO2cK56p2ZPRlC9jbjbeMML7phrfLFS8rCd1Q1TWmgfsqXHxtVwhfXR846tfyEeoSahZa0xa6zlRfWzYAdnx0fDo+Gx8fhPczX9CU2nKFJGFWkMFjX9fK8cxnEaYLhTkqQEr921zvNI2FpmAjyIAzRs/Nz1d3KCJATHDZSRzPhSvqdIz9Iu6JiLtVKnUaoyoVf7q6uPzj9tJDWmnrSq56wtsoMx9ltn0ZsOGXQa8cDh4J23g6WLm4kqiYnPFGb7Yp1RvLUS6x4//J/tOB0rdAI4l6s0m5hXsjm4a2MREMDWa4fOA4IKUUKMy9XFg/ZUSTGZcWnjH555ttufzCXvnSGHSubVeK/HjgsqYvXC5g/ehJ1EyRvMArCzObTA4UF8GwN3ckp5Nw0GaaUctxnmVQuWdpp72Kvj6/u/g9ors3PH1K30ciw5d0g+KvNzeMa75A/d4mklzNaz4n2iDUN9aaYthdr6FOR+2C3BoEBKPoKe70AhRGssXH0Tch0zT/Ann9FLw=
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={"policies_dummy_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/policies/dummy/{policy_uuid}/"}
>
</MethodEndpoint>
Dummy 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":"policy_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Dummy Policy.","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={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"execution_logging"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"result"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"wait_min"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"wait_max"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</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":"Policy uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"execution_logging"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"component"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get object component 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={false}
name={"bound_to"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Return objects policy is bound to","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"result"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"wait_min"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"wait_max"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"execution_logging\": true,\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"bound_to\": 0,\n \"result\": true,\n \"wait_min\": 0,\n \"wait_max\": 0\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 View Git Blame Copy Permalink