Files
authentik/website/docs/developer-docs/api/reference/authenticators-admin-totp-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

345 lines
12 KiB
Plaintext

---
id: authenticators-admin-totp-retrieve
title: "authenticators_admin_totp_retrieve"
description: "Viewset for totp authenticator devices (for admins)"
sidebar_label: "authenticators_admin_totp_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVcFOGzEQ/RXLJ5DSLAVUVTkVlQhFgoJKygVFkbOeZE0ce7G9KWm0/94Z7yZZ2JAD4hRv7Bm/eW/mec1tDk4EZc1A8h4XRcjABJWKYJ0fC7lQZhxsyMcOglOwBN7hEnzqVE5BGPKg4K+HwKbWMTrJXuVgEpYqBc+OaD/m88eYIxdOLCCA87z3uOaKMuUiZLhlcAO/lMS1TzNYCN5b87DK478mwAwcL9/CuGCFUc8FsPoEWwpNX5KgTFfKzFjIlGfD2+Edu4yguniBg+dCOcDagyugHHV4EDPC9IYKjjse0sKpsIqIN9tz/BpRnAOfW+PBE9rTkxP6SS2CMYGWIs815UK0yZMnyOt2dXbyBGloUXwPTgmt/mFVh1kmYh0pGlSFo+Jym9+jhmbWyj/MgGXFQpgvDoQUEw2MApmdVpzJLV0L8XINZoY69b6dowb5fI82xIWQt0avKlaRUxU0nRhc8rJskv5YIYyJRrtzJFKlEZ5vSU3in38qwQ/IroyhrO+cdW0erRlPFWg5Btr3jZTCObHCABVg4dtcE/zUyj0q0I6QUtG1Qt817yt3VOygVcje5ePsE/m4AoMtl7KLu8E7hEgIQuk9RR2qtql7naAhen3pgTLxL/SMzJJTzSBEG6FW5MnrYU2izyQ0J8layTIhJwG33LhN4XQMylWyPEt42Zjte2KoKrEx4dtishDyjS3R9wSEIzdCZMpMbTxZl7ML73C6uSri9OT0vPu9+7VF+Y2Yk0c1CqFu9GqR6zh5pKxIo7IoIVHPM9Da/pjZ7U1dZUkAlB3QiHbzz28GQ0xRlU0l+F6SzFTIikk3tYukkSLZrSbaThK8yiTXg5/9X/f9WGZufUCnaCR/zX3l8ZVHvfdmNPr0g89HLUeAl5DkGjFS3bG+dd0TLQOnYcNwCrZRxF58YagDM6yJItbrifDwx+mypL/xNXFk9rhcCnTgCemK7SOVpzV24VRoDweKO/pdd/wx++D7tLfQjfMY8p2Yh8ajw+ewqh7OcoSnMjRh7E1CXG1cpCnkoRHSsgiahO2EXfWpaYjFxgDUDd/ZLCj7XjjIZTwxtHMwyOcGXaBvAliW/wH23/Bx
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 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={"authenticators_admin_totp_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/authenticators/admin/totp/{id}/"}
>
</MethodEndpoint>
Viewset for totp authenticator devices (for admins)
<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>