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

276 lines
8.9 KiB
Plaintext

---
id: providers-saml-destroy
title: "providers_saml_destroy"
description: "SAMLProvider Viewset"
sidebar_label: "providers_saml_destroy"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SuCThsQxFnbw5DTgi0YArRFsXa9FEEgW0ysRpZUSc4WGP7vI/2RuEvaw7CTvijy8fGRFbcOvIjKmoXkU+683SkJPqyCKPRKQoje7vmI4y7zypEhmt3Pbq7vOlP2qOBXgIhGTnhRQMTvfPpUcUWmTsQcnww+4ElJ3Icsh0LwacXj3jW3JsIGPK//jjNjpVEvJbDOgu2EppMEE9V6r8yGxVwFRnhYD2iMITy8lMoDphR9CfVyxKPYEKpjhhwvA2SlV3HfwBVlzMnvFk9L+uIhOGsCBIJ6Mbmi5TW+W8t6I5ZauacMriYTMswsQjaRtsI5rbKG5OQ50MfqlAObPkMWT5h+FFrJ5iube289seypZlG1uIw1q7UCLVdA72HgUngvqHYqQjG8x5oic7xGsJmVcP5FSKkorNB3w3j4ElXU8Apai6yuT+rX8nH5H/n4Dga8ytjsbvEGIRKiUPpMUu9le9TLU+9gecy0C/pOmniFws8t9ZAEjT3QtANKf8qTg+QSaqqkUrJOqA3A7/pWKb0mS+FUsrtMeD3Q5j0x06Y2UOghiTxG1/cUnVMQnloJESmzto1ll8bx+4hT5Bb8xeTiavx5/OmE6huxpQbrf7UFY0EVTgP1GFVUZE1FsXREOc9Ba/tlYw+RxsoS8VhuwB5p9NoOgpvFA7po06YUwjRJNirmZTrObJEMXCTHXaptmmAok1wvvs5v7+dNms6GWAgzcH4gnBHh7I0pNtDkWwOt4zjC75g4jYEpmQZ01VV3OFCwChgOl2kz5khBOWIjo6pKRYCfXtc1XeNI8zR0cLsTXomU6oMykCrQHlW0FjrAO4A//OgU+5H985A8m10/Owzx1XgigY/4Fvbt/K6XaJWDQCcN5vZhlmXg4uDLSZOTpg898m1+PX+YozkVd6DmTr2jfkMBziJCQhuLB7sFg6T2ACOdCWNd/wEcYV0L
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={"providers_saml_destroy"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/providers/saml/{id}/"}
>
</MethodEndpoint>
SAMLProvider 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 SAML Provider.","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>