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

383 lines
14 KiB
Plaintext

---
id: authenticators-totp-used-by-list
title: "authenticators_totp_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "authenticators_totp_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVV1v2zoM/SuCnu6AIC66PQx5WrcFRYF9FHfdfSkKQ7aYWIsseRId3MDwfx8pO43bJMM27MmUZJLnkNRRJ30DQaHx7kbLhVQtVuDQlAp9iDl6bPI2gs6LXW5NRDmTGmIZTMMu5HANKJTgI+FXQlkrfPENSowCK4WCfMkwcdwl90YFVQNCiHJx30nDQRqFFR05OqCV0WTHsoJayUUncdekXYewhiD75wiuROvM9xbE+IfYKssrzTxWO+PWA4K7z3e34j1sTQlzShDge2sCEGkMLfQPM4lqzZie1UDSSYSyDQZ3CfH+eEOrB/YLEBvvIkRGe3lxwZ/SExiHbKqmsRyL0GbfIkPujtmpENSOUBmEOk72H8v2nPOpigdYQQBXDpRBUFGCAT2pfeBuoxmgErBJpoiB/Li8tddg86EZJ46bzcnts/+rcgDdSXBtzQUuVSyVBgI0WnmtHLOPgLlrrR1NDSvVWuQOPI1Ka4OWN77SbL7dXaUUSw7f99PW3u+zzxLbJ9xGyInQw/OIFKc/mjRm8+rP+numj/8pa3RyFcsQfDjqkfMuXxmwOgc+j78wMvvKE9iS2J4+UVobTqvs7TRff6jDAdqA7Gw9Xv7FelyDo5EtxdXtzZmCaEBl7MlBO892OhBjgEnHx6Q/ocmXArDyrJBrGFSMFGshs6dakbFeZp3RfTaKZpZGOWz3ctcGm9wak21fZrKfiMsXrtF4Mw8S80inQmz2usjrAlRgOSRsxq18+nMkdHCfSc480Li8uHw1fz2/PCr6R7VhxZhQ4XmMpm5sUkruLV2jdIPrVHxZgbX+zdo/Zpobzy2gxgMpYZrcQcw/3txRiIE2U4iLLFsbrNpiXvo6m4TIDlZhfZFRKpd9uHm3/PRlmWg2PiIJxST40+oLrj6/OFoUO3HqtZrM6e8/XGMfEP7HrLEEjgknYt04DkdPBzn51LVFetPGmSCLx68iOuzTdYWK8DXYvudtFm1+aMjcqmBUwS2lydEmsk0juFI2wk+Y/fPvOO4vxB++jSep7mUnKXWKw3djJjewGx7t/oH+qoD0PCTEw8FVWUKDE5cjfeBL8Hi9rpc8L1zHyeyPsz7bGxz9JByqZfrjzm/AUT336JDXDLDvfwCMdxYs
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_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/authenticators/totp/{id}/used_by/"}
>
</MethodEndpoint>
Get a list of all objects that use this object
<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"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"app"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={true}
schemaName={"UsedByActionEnum (string)"}
qualifierMessage={"**Possible values:** [`cascade`, `cascade_many`, `set_null`, `set_default`]"}
schema={{"enum":["cascade","cascade_many","set_null","set_default"],"type":"string","title":"UsedByActionEnum"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"[\n {\n \"app\": \"string\",\n \"model_name\": \"string\",\n \"pk\": \"string\",\n \"name\": \"string\",\n \"action\": \"cascade\"\n }\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>