Files
authentik/website/docs/developer-docs/api/reference/authenticators-sms-destroy.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

275 lines
9.0 KiB
Plaintext

---
id: authenticators-sms-destroy
title: "authenticators_sms_destroy"
description: "Viewset for sms authenticator devices"
sidebar_label: "authenticators_sms_destroy"
hide_title: true
hide_table_of_contents: true
api: eJytVFFv2jAQ/iuWnzYJEUT7MPG0qkUTUltVo9tLhZATH8TFsVPbYUNR/vvuHFJCodU07QXs3J3v++6+u5rbEpwIypqZ5BMuqpCDCSoTwTq/9IVfSvDB2R0fcDxlTpXkjK4/FfzyENjKOoZ+7CiUSdiqDDxGlcKJAgI4zydPNVcUW4qQo8mgAW9K4tlnORSCT2oedmX8agKswfHmbeIrVhn1UgHbe7Ct0HSTlH21U2bNQq48m9/N2U2EMcT3HbxUygGSDK6CZjHgQawJ0hvOHC0essqpsIuAO/MGbwuKc+BLazySQ7Dj0SX9HSO8t6xzYqmVO+JwORqRY2YRtAl0FGWpKSnGJM+eAuvTKtj0GbJwWnyhlYyhbOqcdVRnR60MqsVlrFmuFGi5BLL73pPCOUHtVAGK/ndsM9aONwg2sxLOW4SUitIK/dDPh5aggoYjaC2ypjnpYFuPi/9Yj29gwKmMXT3M3imIhCCUPkPqI7YH0Tx1DywOTPdJP6CJn1D6uaXRkqBxCuJAoPgnPDnWXYIzlNRKNgkNA7htNzCV09G7VMn2IuFNT59zqk5Lr6fSVyJ5CGU3WXRPQTgaKESlzMpGzz2VQ/iAU+aWwHg0vhx+GY5Pyn0nNjRmPQakRK+KUsdho66KLHYV20dl5zlobb+u7WumobJUfGw54JxEzbbr4G72iE+0tImCnyTJWoW8SoeZLZLeE8nhlGqbJpjKJLez6+n9fBppltaHQpje48dFj4vrnQXX0+Zf77p94QP8DkmpEQ0xjEzqfdtP1g32p6DfSdyCJK8cQZNjXafCww+nm4Y+48ZztJHwuBVOiZQah/qQytMZJbYS2sMHLD5938v5M/u3HXqWXrdVDFUwPkPSH/AN7Nrd3izQKwchUXsEuDVcZRmUoRdyMv6k9NfpuZneTh+n6E7l62l8r+lBd6AEZxFhNaPHo92AwYp2AAPdCWPT/AFif3FK
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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"authenticators_sms_destroy"}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/authenticators/sms/{id}/"}
>
</MethodEndpoint>
Viewset for sms authenticator devices
<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 SMS Device.","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>