Files
authentik/website/docs/developer-docs/api/reference/tenants-tenants-destroy.api.mdx
2024-09-13 12:17:54 -05:00

276 lines
8.9 KiB
Plaintext

---
id: tenants-tenants-destroy
title: "tenants_tenants_destroy"
description: "Tenant Viewset"
sidebar_label: "tenants_tenants_destroy"
hide_title: true
hide_table_of_contents: true
api: eJytVEtv2zAM/iuGThsQxFnbw5DTijUYArRFsT4uQxDIFhOrlSVXorMFhv/7SD8St26LHXYSJVIkP/IjK+EK8BK1s0sl5gLBSoth3Z8KAnq3FxNBUup1wZZkd9foowcNvwMgqQvpZQ4IPoj5r0poNiokZqSypDi4XpelVvQY0gxyKeaVwH3Baoqj7ZY0G+dzifTSWNavI59H9/fLi6g1j7QCi3qzZxkzHaI2sSn58fBcag+ECn0J9WoiUG45ux6kWLFRKJwNEDiTk9kZHy/jXbuoN4oSp/ac0dlsxoaps+QKWZRFYXTa1DF+DPyxGkN0ySOkOKrlgzRaNV+jhffOczU9twV1m5d1dr3RYNQaWB8GLqX3krujEfIwrmZNyaZOwdsaqZTmsNLcDOORBjUaeJFam1ldj/rR1uP0P9bjB1jwOo3Ob5bvFEQBSm3eAPUR2iMffvUOVkekXdAPYNITETxzPCYKDHG9oT1RfC7ijlKHsxqwvY6Z7+B3/XCU3vAfWeh4dxoLpmaAtPQa97dcoxakLDFjcj8N4GSIRT88fE9AevBNbtpuXGPZATp+nwiO3MI4mZ2cTb9Ov4yKfiWfeIb6X23roqDzwgBPE/dWpk1vqYlcfJGBMe7b1h0iTbXjFlDjgaalYW47+lfLO3LRwmYIYR7HW41ZmUxTl8cDF/FRSoxLYgpl48vl98X17aKBWbiAubQD513Jo/58Z2UN6DneXl15Ef5gXBiKyTiafKuuxcetMRlI85dLjQmVUYJsXlWJDHDvTV3z83MJfk/vJO6k1zLhJhEXlA4sE6k20gT4IOlPPzsCf47+eQe+iatfHZZrtJOm5BuJT7B/tabrFZlnIBVxjJNtLc7TFAoc/B0NOzP6MCsXi8vFHTfvL8RmOC8=
sidebar_class_name: "delete 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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"tenants_tenants_destroy"}
>
</Heading>
<MethodEndpoint
method={"delete"}
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={"204"}
value={"204"}
>
<div>
No response body
</div><div>
</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>