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

344 lines
12 KiB
Plaintext

---
id: authenticators-totp-retrieve
title: "authenticators_totp_retrieve"
description: "Viewset for totp authenticator devices"
sidebar_label: "authenticators_totp_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVV9P2zAQ/yqWnzapa1BB09SnoYFQJRhodLygqnKSa2Lq2sF2Oroo3313TtoGUtg08VSnvjv//pzPFTcFWOGl0ZOUj7kofQ7ay0R4Y93cG1/MLXgrYQ18wFNwiZUFhWPwnYRfDjxbGMsokj3LZimsZQIO0wphxQo8WMfH9xWXlFwIn+OWxg38kimuXZLDSvBxxf2mCP9qDxlYXr88+ZSVWj6WwNoIthaKvlI6fbGROmM+l45Nr6c37CzgGOIBFh5LaQGJeltCPRtwLzLC9II3xx0HSWml3wTE2+0lfs0oz4IrjHbIDtGOjo7oJzEIRntaiqJQVAvRRg+OIFd9diZ+gMT3VL0FK4WSv5HV34W1ZJ+XDY5Gy119h7bprFd/mgPLy5XQnyyIVMQKGCUys2g0S3dyrcTTJegMfRp/PkEPiuUBb0gLkV5rtWlURU2lVxQxOeN13RX9vkEYCs32cWRS4xHG96wm80/eVeA7VDcNqezcWmP7Oho9X0hQ6Rxo33VKCmvFBhOkh5Xra03wE5MecIF2RJpKOlaom+559V6KPbQG2at6HL+jHhegseUSdnozeUWQFLyQ6gCpt9h2fW8LdExvD32DJv6FMyM3NJYy8GGMUCvy6PlljeiGRJVM64hmCNj1ds6UVoXwQkbr44jXnVt9S9o05Dp3e0cj977YDiT6jkFYmkOISeqFCZEtkX36gNPJDfzR0ehk+GU46ol9JZY0nToUqA+dXBUq3DnyVCTBUzSPROc5KGW+ZmZ30lAakh4NBxxB+5vPryZTLNHQJgpuHEWZ9HkZDxOzijolov0qViaO8CgdXU6+nX+/PQ80C+M8zohO8eeqN3Pptaeh05v//kq02nt48lGhEBCRDGSq1vrenMYkE5wahweEGixH4BRZVbFw8NOquqa/8bGwNMtxuRY4YGMyD3sklY7W2GQLoRy8wePDj7ahP7L/fH4OEtwOFk1jJdSh7h/wJWyad7GeYVSOMxYbkBA3G6dJAoXvpPQmALX77gJdnFNnkHqdLm+7erBdUPWDcFDLEDE1S9Co5xadp28CWNd/AO793og=
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={"authenticators_totp_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/authenticators/totp/{id}/"}
>
</MethodEndpoint>
Viewset for totp 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 TOTP Device.","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={"name"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `<= 64 characters`"}
schema={{"type":"string","description":"The human-readable name of this device.","maxLength":64}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"ID (integer)"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true,"title":"ID"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"name\": \"string\",\n \"pk\": 0\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>