first pass

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

View File

@@ -0,0 +1,555 @@
---
id: providers-radius-create
title: "providers_radius_create"
description: "RadiusProvider Viewset"
sidebar_label: "providers_radius_create"
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIvWwDbCtN0rTL07I0KwxkbZCk3UMRGJR0slhTpEZScV3D//vuSNmWHTlxgG59WB8MyNLxfn787sh5pCsw3Amthll0GlVG34sMjB0ZnonajlID3EHUizKwqREVSaLctf961UizjwKmFhyKOT620emntaLorhcZ+LsG637X2Sw6nUepVg6Uo0deVVKk3n782ZLqeWTTAkpOT25WARrTyWdI3VM+3IARXIqvYFASzWNcToAlPYqX0NJnnRFqjFKlUJegxq6ITl8sehGvXYF+Nf6McqmnXatybUqO3kd1LTL8r2opeSJRxpkatr38A7Ww2kLGcB3bNMGm+IfhG8at1anATGeslRImLONpCpaWJzPGFatVv6UDX6NqM4ga77URX5/n/C5nvWdLlbgUvURnllX1Bpscz0YluowitmWPG8NnqF44KO3TfixQXSoFRjVS4KbaTDoXteu17fqlsI7pnJ0P31xb9nOqy5L3LVTcUJp+Qf+5Y8GGZSlmElGoEFYsN7ocsDNWagPMVpCKXKReDZsKKRm6mRYsgZy+cya1xowzrWDAzpfqgipKE2lDKaVVv9GFyVwrS4BlmLYKMp9CW3AD2cgCbjP33Ihv/GIWFqNmNwWs2TJEruiTuUdfnWYFtwWreDoBZ73lMucjW1eVNm27idYSuHqAi78IDaAI5VkPw82gn3CCSVlLJ/o5T91DcFOSMd56CV6MWmWUI46OlSLVEoXITdoAt+9vr7xi8pZeVLglEAjZgN0S8myha5lh2uWMlDa+MJEzjmmlTWBDiUOaBanVm6DFJNxTBb2pDO5FClS5XIxrQ2FxyzRaNlNhSWzpAAJgxoRKtTFY42DeADFSsC8caXFcKNuObOBBTcwnUDtRYscG7QVqQop0whGDbJHadSBOVLWhi3iG0ANpbYRDTv00X5HXBP/dLTzp2korGxjw8ODFd2HeatLSJtD42AthU8neYymXlLmMfviGsNlN1z8I+nsTtC4RUA18tsU33XyLhBSww1armNXNDgU2URhGgT/co5DhDqIUr8C2iQ7KnLVirJAoW6kfWVmPn/ZkiJgzisuNqhHAeiGNQrEP15fIifua3TVLbJo9W6/4ybJM2Eoii7zDtY9bSpCi04JjO5HfK9hdLvwrgWN7SrCf7qn8GlxtVAMUVL+x+gnto0rWhsvnGwnrnrRVguOjEhuYfF4wYlkzv5btUr/HdPR/mIe+4QSka1dp60Z2w9ITvLjoqvyPUeo/H6V2MvNjzWJfktuXjztbertPPmSFZrjZRF+PxqQtLuwmr52DYpgQN5FGYD0+OPiGc99HnPKygMgLY3THQZuyIEBmI6Dvzxg4woCRdc191JwyHBLQLJdXbXuLdTrWrgXPdubj6Bvm4y0oHH1TdnY13JGQDOsvOprOo9G2kd4oaBW+MfpImKEbFdpf6CDIyCtOR8goXl3LxOF+J47oGEEcaf0pojaSxHgl4vujOKJzxPKUcUNJCVG1zhor/wvnKlLmpYj/ALnZeGcordfrK6CLL7ysJKwvZtb03jngR0c5f/0yPznuv3z14lX/+OXJYT85ytP+YfrryVF+csJzftK9Gfde2zEqf9pv7V1Hb14HtNXQWgf7dtNoGolQufYZbSq9TrNnAxvqe3hweDx4PTh8gMY/+cS3hM3WYQUle+B5Cak19aBHdBMqowKk1L+N9crSQGjCJu4IwKNjq0R/Dm9RRYAHldqexvFYuKJOBsh3cUtFvH5KpE5iNKXiy+H5xbubCw8HgmTJVUv5CpUsoJJ13zq29u0jF5ABjg6+uBhnT6EoHu/3vNkF7ctJ3GxeET5QJQvaLSgwn1NP/mDkYkGvEbqGTtn4eM/xrOvPknjKxgU4DCDKaetMAEWi8+Bh/5bcIHFZ+1Jus8yit1xxhufHyj0qe9fa0Ffvb6gSSXOXWnoWwSimPhaCPHUXnzG/V/27eSS5Gtd8TLJB56I5kbZHlrBle8sHimrJ3mrW8hDT4yVu9QQUpqjXhOLoP7qLyv8BGPflVA==
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={"providers_radius_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/providers/radius/"}
>
</MethodEndpoint>
RadiusProvider Viewset
<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`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication_flow"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authorization_flow"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_networks"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"List of CIDRs (comma-separated) that clients can connect from. A more specific CIDR will match before a looser one. Clients connecting from a non-specified CIDR will be dropped."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shared_secret"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Shared secret between clients and server to hash packets."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"mfa_support"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon."}}
>
</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={"pk"}
required={true}
schemaName={"ID (integer)"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true,"title":"ID"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication_flow"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authorization_flow"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"component"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name_plural"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"meta_model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_networks"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"List of CIDRs (comma-separated) that clients can connect from. A more specific CIDR will match before a looser one. Clients connecting from a non-specified CIDR will be dropped."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shared_secret"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Shared secret between clients and server to hash packets."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"outpost_set"}
required={true}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"mfa_support"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon."}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": 0,\n \"name\": \"string\",\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"assigned_application_slug\": \"string\",\n \"assigned_application_name\": \"string\",\n \"assigned_backchannel_application_slug\": \"string\",\n \"assigned_backchannel_application_name\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"client_networks\": \"string\",\n \"shared_secret\": \"string\",\n \"outpost_set\": [\n \"string\"\n ],\n \"mfa_support\": true\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>