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

367 lines
12 KiB
Plaintext

---
id: authenticators-admin-totp-create
title: "authenticators_admin_totp_create"
description: "Viewset for totp authenticator devices (for admins)"
sidebar_label: "authenticators_admin_totp_create"
hide_title: true
hide_table_of_contents: true
api: eJzNVk1v2kAQ/SvWnlqJYPKhquLUNEEVUtKghuYSRWhtD/aG9a67uyahlv97Z9YGTCCpVOXQC7LXM2/mvflYKqYLMNwJrcYJGzJeugyUEzF32tgZT3KhZk67YhYb4A5YjyVgYyMKckGHOwFPFlww1yYgu2AHIUhgKWKwwQf67tHsR8RwPLVseP8iHHvoMQO/SrDuq05WbFixWCuHBvTIi0KSIcYNHy0Fr5iNM8g5PblVAZiOjh4hdntZ3oIRXIrfYP6SKHoWhiRxAl8QV/EcOvjWGaFStEImV6BSl7Hh8cto0wyCrMy5OkLNEh5JCAgm0PPAZcK2sfqEwp/XKJ/O6rqhLwwkJI4PjZI44STFnt5MJ5fe9UcjEqt3XZwpAQ8sxKURDvW7rzYKL/DtofYC20Ir27A7GRz/1yq/j64YbdFBF0g2BcNIC57cKLlqpNsqPb5kB4vhgQ5WpCnFbroMT84Gg3cU+A7VTbxrMDJGm30dtZrNBchkBvTddiC5MXyFDsJBbve1pvRjnRyoAn3hSSIoLJeTbrx6K8U2tSazV/U4fUc9voHClouD88n4FUEScFzIA6TeYtutewvQKXob9A2aeJSDyzQt1EJbyrvg1Iss3F14od+IIQ1KyGhwzRKoaDi3pZHevhDh8jRkNLnrub4ldRp6neneEMmcKwjMW+F7BNyA8VmRvj+2C3b0zPNCwnYAO+oINdcetGW9jdRjlGTD9WRwctb/3D/eq8w1XyBQd/qpaa2geDSg1AA89g2AlaYKsQyk1F9SvYnUF5oywe4A3FedLK/HU4RoFCK2dhiGqXBZGfVjnYcdiHD7FEkdhRhKhVfji9H325FXhMqDC6UDvluh5s5qVtnhG7DTzP96GTZ1c/DswkJihsTas6vavtm7KGki0Z2cta82NWhGrYa2VRVxCz+NrGs6xnIbugvwcclxQUdUT7wL0AHXH3YGtdsC0IRdNEyOppQRmcvSS/JyROve2uM8jqFwb9o+dKZhcnNLpYva2z33I8gMf6JljL84PT38R0Levr/9WcUkV2nJU7JtMP1OKkmaTdu3bd5bPxCr9epTq06GKI+3mOoFKJSo11Jx9I7pIvgf7PMomQ==
sidebar_class_name: "post 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_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/authenticators/admin/totp/"}
>
</MethodEndpoint>
Viewset for totp authenticator devices (for admins)
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3><strong
className={"openapi-schema__required"}
>
required
</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:** `non-empty` and `<= 64 characters`"}
schema={{"type":"string","minLength":1,"description":"The human-readable name of this device.","maxLength":64}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"201"}
value={"201"}
>
<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>