eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-27 01:55:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

first pass

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

422
website/docs/developer-docs/api/reference/tenants-domains-partial-update.api.mdx Normal file
View File

@@ -0,0 +1,422 @@
---
id: tenants-domains-partial-update
title: "tenants_domains_partial_update"
description: "Domain ViewSet"
sidebar_label: "tenants_domains_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJy9VlFv2zYQ/isCnzbAtlI7cTs/LcuCLUC7BUnWl8AwTtLJYiORKkml8QT/992R0qTOjoEB3fxgUOLx+N13d9+pFbpGA05qdZOJlXCoQDm7yXQFUtlNDcZJKDdNnYFDMREZ2tTImg+Q+c/eLPoo8cs9Otome6jQobFi9dgKyUY1uIK2FG3Qk8xobdMCKxCrVrhd7d8qh1s0Yv/PGy6jRsnPDUadRfQMJT9lqJzMd1JtI1dIGwUkM/Jt8HMjDVI0zjS4X0+Egy3D6YMT62CE1v2ksx2jSDV5V46XUNelTD0j8SfLGNpDuDr5hKl7jY57NMSZ/JPiIUYMM+wkWj4feB15ss5QDGRXSfUe1ZaoWr2hJ3jpn+YXC2JFUi6MrMDsRocTrUsExayF2I45zrWpgHZE0xD3e7aVrmSTW3AUWBZQ3wVGyIBNDNpaKxtAz8/O/leSCOZhZTAmyH5X5a5L7OQUmf8lfUOBPfYQJqGsOy/rgeIQrPCcfk0D33r+TYn9SHRm/mh0bYw+5FVptcklltkGed+OXIIxsOMwHFb2kAaGn+oMj+9Alkm+Fsrb8X2jShugBWSv8rH4hnz8gopqLI0ub29eISRDB7I8EtSpaL9Kf3AwSnh36Ykw6RUpZKGzII1p4WWTS1XEnULFnfzGrcz2MeslmudeUxtTsinUMn5exIIFzmLaGOl298xMCA0aV7BEPo2CKJyre/H19Y9gWHMJEXN7N2ji9QtUdYljxRo6YtxL3IlD94hFDu8u8uX59OLtm7fT84vlfJos8nQ6T39YLvLlEnJYMrtS5doD61gb0E4EBxq4mp/Nz2fvZvODzH6AJxb+/lSoj8hKxswjgAsIUl9AVCmcYVFgWeoft/rvm2ZSMxKqLiSd8+0RBtSHmwdyEVhmxuwqjrfSFU0yS3UVj1zEwyopdRIzUfH7m6vr3+6vPau1tq4CNXLeJTjqEhx18zU6Pl9HrXA4arukOnxxcV16lelgt109DROv10perbxUcc0WBI+t2jYBi3+Ycr/n11QFnNpHWj4DiXTCKaLCy6TlNdVtDqXFE1i/u+t65Pvo38/vo3H1MqVYpLwL7qWJeMJd+KbYr8mqoAlBBc1gw8ZVgDR94OPDwQNV2U/6E5dpirU7abseNfDt5cPVr2SddB8SlZcNYeALDyz69yi158j3pX/XihLUtoEt2wan/PsLauZIEA==
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={"tenants_domains_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/tenants/domains/{id}/"}
>
</MethodEndpoint>
Domain 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 Domain.","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={"domain"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty` and `<= 253 characters`"}
schema={{"type":"string","minLength":1,"maxLength":253}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"is_primary"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tenant"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid"}}
>
</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={"id"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"domain"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 253 characters`"}
schema={{"type":"string","maxLength":253}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"is_primary"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tenant"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": 0,\n \"domain\": \"string\",\n \"is_primary\": true,\n \"tenant\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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>