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

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

362
website/docs/developer-docs/api/reference/tenants-tenants-retrieve.api.mdx Normal file
View File

@@ -0,0 +1,362 @@
---
id: tenants-tenants-retrieve
title: "tenants_tenants_retrieve"
description: "Tenant Viewset"
sidebar_label: "tenants_tenants_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zAM/SuGThsQxEVaDENOK7qgCNBuxfpxKYpAtplYrSypkpw1M/zfR/ojUeuk26EnySJF8j1SzxXTBiz3Qqt5xqbMg+LKu0W/WvBWwBrYiGXgUisMuaLjTeMQ3Qn47cCj2XDLC/BgHZveV0yQk+E+R5NCwzb2oixFhocuzaHgbFoxvzFkdphJrdCy1LbgHk8az/pt5tPo9nb+PWrdI5GB8mK5ob3PhYvawsYYx8JzKSwgLG9LqB9GzPMVVdejZA/k5IxWDhxVMjk6oiXVCj08bbkxUqQNP/Gjo/zVsHKdPELqD1F0DVZwKf6AJZYs8e1Fmy9k5J9EUK08+6nkpgPUc7ho+R3eL/jLBagV9mD65bju+/DWr24DbwJLorUErlhdhyzetwFepx29AkEcCy9hix5DDBpIGU8+lOk75DdrrkYza/WQaKXVYilAZgsguwtCcmv5Bi8ID4Xbww4Wm+psH29o4VkmKC2XV2G+ekfDrrS2soN8HH8gH+egcOjS6PRqfoCQDDwXcu8wHEYbjkIXIGh4l/QdmHiECpFrEppVJxo0nCzuHuR2rYKhqmMaObDrXlpKK+kONyJeH8eMHraDtLTCb66JoBYhL31O0vAUYMm9N/38NnMO3IJtChNqqRvPDs3u+ohR5hbD5GhyMv46ngwYv+RPpED9rbZvkROFkUBaRI3ladNY7CAxz3KQUn9b6W2msdDEP3YdUJCasW2F83J+gyFa2ATBTeN4JXxeJuNUF3EQIt7tEqmTGFOp+GJ+NvtxPWtgGu18wVUQvKM86tdDih8M51D8O349vPjYSExKQJqCq67HO9EdBbvp638CjVOOFZJ7VSXcwa2VdU3HzyVYlKh73K45CmpCXcJhyISjPY7UkksH7xT96Vc3vp+j//6F7MXVC4ci2VhzWdIXbp9g8+YvVz+ge47iikNGxbYep2kKxgd3B0+dRnr7Us5nN9i6vzRwpdc=
sidebar_class_name: "get 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_tenants_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/tenants/tenants/{tenant_uuid}/"}
>
</MethodEndpoint>
Tenant 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":"tenant_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Tenant.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><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={"tenant_uuid"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"schema_name"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 63 characters`"}
schema={{"type":"string","maxLength":63}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"ready"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"tenant_uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema_name\": \"string\",\n \"name\": \"string\",\n \"ready\": 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>