first pass

This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions

View File

@@ -0,0 +1,579 @@
---
id: providers-rac-update
title: "providers_rac_update"
description: "RACProvider Viewset"
sidebar_label: "providers_rac_update"
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/RVCL9sCtpU4l3ZdLLDZJC0CpN0gl+5DYBiURNusaVIlqTiuoX/fGVKyZEd2nKK7femLQVnDuZyZORxqEaiUaWq5khdJ0AtSrR54wrQZaBoPsjShlgWtIGEm1jxFMRC6Pjm9KuTIZ85mhlmQSammU2Zhb9C7XwQcJVNqx/BKwgt44gmsTTxmUxr0FoGdp+5fadmI6SBfN3NCMsm/ZowUEuSBCnxKmLR8OOdyROyYGwLukNKfDljQ7GvGNYNwrM5Y3m8Flo7QqSq6oO/FmLF/qWSO3sQKrEiLS5qmgscOlPCLQV8WT91W0RcW263Y3DDNqeDfILgW2gakLWcGlXhElsqM1RAOSE25vGRyBKj19gEQmtkxRuudGQyFmjXtGio9peB6kGUOY5kJQSPBPALrLr4HLSQzLCGwj6yaIDN4AFgZocaomEP6E1LDgwDeNI6Zwe3RnFAJSWrXdMDfoBryUHivNP/2Muc3Oes8K1Uuk58uE58vMZ4PpuAyiJiaPao1nYN6btnUPO9HDuqgrm2hBZ6gQCRkHENhjynX8+fytx7KGTYHCDBDxhCUUBADJQawRGAFNdZ0yBkb0kxYooZkj0wZlQbipNalpBA1XhaAt1y4F5FW0IQakxMLBWB1yKv3LpwemMq0+aO9/w4sZ5bBsvvOMAgmgeXBa992AlwbWDVhcgDhJdwUwdZCjJQS4M6TBP2DaQGkiFXEVRupgCJOpSEzLgSJGPGGoEJSeFdZ6Ti0q7a9b6qcgkWwm7nF0q632rXvZdCTP+l/zGOcaW7njpfKWp3AUz93PGDAHeP7sru39/+TQTppoEN0jCZ/SzEvu7iM++IMk9bMIL844ydzRqymUE1F7ayLr7r5AZrGFw5Z7iJG+X6fMTKREAYyBXQWS7jngGWlrVYHIgfkMJIsGdSgHxiRjZ735AJqTksqVrKGBdbyMHJJ7q4vTWdns5uOt7UDvtrxm0E+SAWdk0+wd7uliMaTeEyBO8TPCnaTC/9J4A9MR8DqOyq/ZjbTsigUUL+y+xntg1RkmoqXG/H7nrUF8yEdTBWcAy8Lhpc5c3vJJvWrB7bKbKqMHeB4unNP5w1qdzr5f53133vWbySQbZy2ay/uShuNJ0+dzp8Wb3EGrxZaC0/ztZZt7rHmScaPMKuwY94Of+hg8hkmkcQz37nWquF+ghBwJpIBw/cvOBT9IZg0zSZIoAkcZGCWiqu6vbzConLNe7YRj4MfiMcHJmE8i8nJ1cUGQBJIPm8gxq3R1su8UFDLemF0S5ieMcfK3cwzf8nGq0UQLm+yIdzTwwVP8hDv1kw/lPfvTAsUpCkPHw7CACfdcg6+QVR8WLVpeBnA2Nq0vKg7NmBUu8JsBYjrdXVvPn+k01Sw6kJb0WHjFBocDOnbo+HxYfvozf6b9uHRcbcdHQzjdjf+/fhgeHxMh/S4uRV33tswz93vtre/w42vzvebibQ4N7gcKodrkfAKbMcIxqe5u9c97LztdJ8U5Uc6wZF1bdg2HCHvOG6SlnrehiLH4gzGTAj150gtLXW4whKFxgBurifq48UtqPBFggk3vTAccTvOog5wXlhTEVarSKgoBFMyvLw4Pf90c+6KArlvSmVN+bI6CVQnaf6KVOvdDR+UinK07NGGMCBxiZE4jxdFH9S/6EC30Rh+e+5CgMkcg18os1hE1LA7LfIc/4bqxUzew/KBwp3M3XmgYSCBuIZeG1Jh1m9AdXdfXRd9/Zp87zeqxthKgpVIr04RskArmLC5/3qW90FqDOMJtCO67F+cesfat7i92viED/NWueMEbmOp3Srbr1HP1R3WSlR8KJs6ugO0Zw7zmfdROZwcp7j/FoGgcpTREcp6lXlxvasPGp5aWuUCg2pEAXLoJG6x3SCPJSiu/RCXPP8X05tRQw==
sidebar_class_name: "put 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={"providers_rac_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/providers/rac/{id}/"}
>
</MethodEndpoint>
RACProvider 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":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this RAC Provider.","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><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={"authentication_flow"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authorization_flow"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"settings"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"connection_expiry"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"delete_token_on_disconnect"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When set to true, connection tokens will be deleted upon disconnect."}}
>
</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={"ID (integer)"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true,"title":"ID"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication_flow"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authorization_flow"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</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={"assigned_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","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={"settings"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"outpost_set"}
required={true}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"connection_expiry"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"delete_token_on_disconnect"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When set to true, connection tokens will be deleted upon disconnect."}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": 0,\n \"name\": \"string\",\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"assigned_application_slug\": \"string\",\n \"assigned_application_name\": \"string\",\n \"assigned_backchannel_application_slug\": \"string\",\n \"assigned_backchannel_application_name\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"settings\": {},\n \"outpost_set\": [\n \"string\"\n ],\n \"connection_expiry\": \"string\",\n \"delete_token_on_disconnect\": true\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>