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

276 lines
8.9 KiB
Plaintext

---
id: rbac-roles-destroy
title: "rbac_roles_destroy"
description: "Role viewset"
sidebar_label: "rbac_roles_destroy"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SuGThsQRFnbw5DTijUYArRF0Y9dhiCQLSZWI1uqJGcLDP/3kbKduE1a7LCTJZMiHx8fWTNjwYmgTDmXbMpcKrKlMxr8UoIPzuzYiOEpc8qSE7rcozXZKvjtIaDRCicKCOA8m/6qmSIXK0KOphINeKsqJfHmsxwKwaY1CztL/zG8KtdoWRlXiNB7Nm8TXiZPT/OrpHVPlIQyqNWOziFXPiE8Y4zi4KVSDrCK4CpoFiMWxJpAxaIY3j1klVNhF4GKKuQUaYO3BXk78NaUHjxBPJtc0Oc1kFuT9E5JauSOoF5MJuSYmTJgNDoKa7XKIqX82dPD+rh2kz5DFo64/Sm0kvFpMnPOOOLXUYeCanGVplyuFGi5BLL7QUjhnKBuqQCFP6a5QbCZkXDaIqRUlFbou2E+tAQVNLyC1iJrmqNGtXyc/0c+fkAJTmXJ5d38HUIkBKH0iaI+qvYglV99gMWh0i7pB2XiL5R8bmhiJGhUfxwEFP2UcVIbjyPEaxJ0w0n84Lb9iFROk5+wim/POWsGynwgXtrCBvrcl5CHYPtJonsKwoGLeFS5MtGzK+LwfMQocwv9bHJ2Mf46/nJE9I3Y0ED1r9p2JV4Vth0u6qfIYj+xcUQ4y0Fr821t9pnGyhDt2GzACYlqbRfAzfwRQ7RlUwl+yvlahbxKx5kp+CAEP5xSbVKOqUp+Pf8+u32YxTKt8aEQ5SA40Z1EupN3NtZAjW+XV8drgD+BW43JqIAItO762W0P1AylwO+0W2ekmBzRkEtdp8LDk9NNQ79fKnC0ZPC4FU6JlDqCjZfK0xlVsxLawwcwP913Cv2c/OP2O1lJvxlK4mQrdEU3PG5gt9+2C/TLQUjUEWFsTZdZBjYMHh0NMal2PwNXs+vZ4wzdqX0DvXb6HPUHSnASExIYPR7NBkoksYcY6E4Ym+YvJ/JIjA==
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={"rbac_roles_destroy"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/rbac/roles/{uuid}/"}
>
</MethodEndpoint>
Role 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":"uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Role.","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>