eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-27 01:55:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

first pass

Browse Source
This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

383
website/docs/developer-docs/api/reference/authenticators-sms-used-by-list.api.mdx Normal file
View File

@@ -0,0 +1,383 @@
---
id: authenticators-sms-used-by-list
title: "authenticators_sms_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "authenticators_sms_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVU2P0zAQ/SuWTyBVzWrhgHpigWq1EosQC1zQKnLiaWPq2MGeVFRR/jszTrrNblsEiEvrj8z4vTfj5076BoJC492NlgupWqzAoSkV+hDzWMe8jaDzYpdbE1HOpIZYBtNwBH1/DSiU4C3hV0JZK3zxHUqMAiuFgmJpYOK4SuGNCqoGhBDl4lsnDSdpFFa05WiDZkbTOJYV1EouOom7Jq06hDUE2T9FcCVaZ360IMYvxFZZnmmmsdoZtx4Q3N3eiXewNSXMKX+AH60JQJQxtNDfzySqNUN6ooCknQhlGwzuEuD99oZm9xwXIDbeRYgM9vLigv9KT1gc8lA1jeVcBDb7Hhlxd0xOhaB2hMog1HGy/qDaU8qnBA+wggCuHBiDIE2CAT2RPnCt0QxQCdjkpIiB4ljd2muw+VCLE9vN5uTy2e9VOYDuJLi2ZoFLFUulgQCNo7xWjtlHwNy11o5DDSvVWuQKPM5Kc4OWF75Qa77ZXaUjlpy+76el/bY/fZbYPuI2Qk6E7p9mpDz9UaMxm5f/Vt8zdfyqrNEpVCxD8OGoRs67fGXA6hx4P/5By+yVJ7AlsT29o7Q2fKyyH6fn9QcdDtAGZGf1ePEf9bgGRy1biquPN2cE0YDK2JONdp7ttCHGBJOKj4f+hiZfCsDKsz+uYTAxMqyFzB57RUZumXVG99lomVnq5LDdm10bbIpqTLZ9kcl+4i13LNF4MQ8O88CmQmz2rsjzAlRgMyRoxq18+nLkcwifST55YHF5cfly/mp+eaT5rdqwYUyYcDtGUzc2GSWXlm5RusB10l5WYK1/vfYPJ82N5wpQ3YGMMDXuYOW3N58pxUCbKcRFlq0NVm0xL32dTVJkh1FhfZHRUS57f/N2+eFumWg2PiL5xCT5Y/EFic/PjRbFTpx6qiZd+vev1lgGhJ+YNZawMd/Eqxub4ejhoGrV/LtI79nYETTi3quIDId0XaEifAm273mZHZtfGRpuVTCq4IJS32gTeUz9t1I2wm+IPfs09vpz8W/v4kmie8tJLp3S8L2YyQ3shve6v6evKiAvDwnwsHFVltDgJOTIG/gGPFyt6yU3C6s4afyx0Wf7AWc/CYekTF989htwJOceHfKcAfb9L2L6E7Q=
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_sms_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/authenticators/sms/{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 SMS 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>