eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 17:45:21 +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

375
website/docs/developer-docs/api/reference/authenticators-admin-sms-create.api.mdx Normal file
View File

@@ -0,0 +1,375 @@
---
id: authenticators-admin-sms-create
title: "authenticators_admin_sms_create"
description: "Viewset for sms authenticator devices (for admins)"
sidebar_label: "authenticators_admin_sms_create"
hide_title: true
hide_table_of_contents: true
api: eJzNVk1v2zAM/SuGThuQxmlaDENO69pgCNCuRZP1UhSBbDO2GlnyJLltFvi/j5SdxPloDkMPuwSyTT6S75FUlkwXYLgTWo0SNmC8dBkoJ2LutLFTnuRCTW1up7EB7oB1WAI2NqIgD7R/EPBqwQUzbQI0C7b8gwReRAw2+ESfPZb9jBCOp5YNHneCsacOM/C7BOu+62TBBksWa+XQgI68KCQZYtjw2VLsJbNxBjmnk1sUgNno6Blit5fkGIzgUvwBczxPdCwM8eEEPiCs4jm04K0zQqVohYVcg0pdxganu8EmGQRZmXN1gowlPJIQEEygZ4HLhG1idQmFv61QvpxXVV29MJAQNz40MuKEkxR7fDO+8p73NUWs2vZwpgR8YSEujXDI3uNyze8cn54qT68ttLJ1cf3e6f/M8cewitHmLXSBtaZgGFHBk1slFzVzG55HV4ycMq1gqso8QuMDyW17H9RuB8QnckjPWsjtaimF817vA+V5QG0S7xoMjdFmXwatpjMBMpkCfbctSG4MX6CDcJDbfTYo/VgnB0SkLzxJBIXl8q4dr9owsUmtzuxdPs4+kI8foLBh4+DibvQOIQk4LuSBoo5V2+6CBqCleRP0SJn4KgeXaVrFhbaUd8GplVm4vSxDv01DHLOQ0dSbFyDNcOhLI715IcKXs5DR2K+WwpjIqatrrYZ1HZlzBYF5K3yOgBswPimi936zm4dvPC8kbMa3RY5QM+1Bm6I3kTqMkqxL7ff6592v3f6eMDd8jkDt3UE9awXFo/Em/Xns9UehSSCWgZT6W6rXkbpCUybYHIDLrpXlzWiCEDVDVK0dhGEqXFZG3VjnYQsi3JwiqaMQQ6nwenQ5/DkeekZIHVxHLfBtgerrzu/Bw1dnq5X/8RatVXPw5sJCYn5Us69t2TTN3g1L44juJHJOT9ScGbUZmi6XEbfwy8iqoteotaFbBI8vHFd7RGLiLYIOuPtoK2KvzQFN2GVdx8mEEiJzWXo+dsez6qw8LuIYCnfU9qk1CXe3Y9Itav4V5H78mOGvtInxFyeng/9jyNs3t3+3ZJKrtOQp2daYfh+VxMy655se76wOVNVq7alFK0Okx1tM9BwUUtRpSnH0jOki+F8V7Dsr
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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"authenticators_admin_sms_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/authenticators/admin/sms/"}
>
</MethodEndpoint>
Viewset for sms 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><SchemaItem
collapsible={false}
name={"phone_number"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"name\": \"string\",\n \"pk\": 0,\n \"phone_number\": \"string\"\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>