556 lines
23 KiB
Plaintext
556 lines
23 KiB
Plaintext
---
|
|
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: eJztWEtv2zgQ/iuELrsL+JFX025Om02zhYG0DZK0eygCg5JGFmuK1JJUXNfwf+8MKduyIycOkN0ctgcDsjSc58dvhpxFugTDndBqkEYnUWn0nUjB2KHhqajsMDHAHUSdKAWbGFGSJMpd+a+XtTT7LGBiwaGY4yMbnXxZKYpuO5GBfyqw7k+dTqOTWZRo5UA5euRlKUXi7fe/WlI9i2ySQ8HpyU1LQGM6/gqJe8yHazCCS/EdDEqieYzLCbCkR/ECGvqsM0KNUKoQ6gLUyOXRyf68E/HK5ehX7c8wk3rStirTpuDofVRVIsX/qpKSxxJlnKlg08u/UAurLKQM17F1E2yCfxi+YdxanQjMdMoaKWHCMp4kYGl5PGVcsUp1GzrwNao2vaj2Xhvx/WnOb3PWe7ZQiUvRS3RmUVVvsM7xdFigyyhiG/a4MXyK6oWDwj7uxxzVJVJgVEMFbqLNuHVRs16brl8I65jO2Nng7ZVlvya6KHjXQskNpek39J87FmxYlmAmEYUKYcUyo4seO2WFNsBsCYnIROLVsImQkqGbSc5iyOg7Z1JrzDjTCnrsbKEuqKI0kTaUUlp1a12YzJWyGFiKaSsh9Sm0OTeQDi3gNnNPjfjaL2ZhMWp2E8CaLULkij6ZO/TVaZZzm7OSJ2Nw1lsuMj60VVlq07Qbay2Bq3u4+JvQAIpQnnYw3BS6MSeYFJV0opvxxN0HNyUZ460W4MWoVUo54uhYIRItUYjcpA1w8/Hm0ismb+lFiVsCgZD22A0hz+a6kimmXU5Jae0LExnjmFbaBDaUOKRZkFq9DlpMwh1V0JtK4U4kQJXLxKgyFBa3TKNlMxGWxBYOIACmTKhEG4M1DuYNECMF+8KRFseFss3Ieh7UxHwCtRMltmzQTqAmpEgnHDHIBqldBeJEVWu6iGcIPZBURjjk1C+zJXmN8d/t3JOuLbWygQEP9vZfhHnLcUObQOMjL4RNJf2IpVxQ5iL6wVvCZjtd/yTolyZoXSCgavhsiq+7+Q4JKWCHLVcxq+sdCmysMIwcf7hHIcUdRClegm0dHZQ5a8VIIVE2Uj+0sho97skAMWcUl2tVI4B1QhqFYp+uLpATdzW7bZZYN3u6WvGLZamwpUQW+YBrH7YUI0UnOcd2Il8q2G0u/CuBY3uKsZ/uqPwKXGVUDRRUv7b6Ee3DUlaGy6cbCesetVWA48MCG5h8WjBiUTO/lm1Tv8N09H+Yh55xAtKVK7V1Q7tm6RFenLdV/uco9Z+PUluZ+aFmsSvJ7crHrS292Sfvs0I93Kyjr0Nj0gYXtpPX1kExTIjrSCOwHu3tPePc9xmnvDQg8twY3XLQpiwIkOkQ6PsTBo4wYKRtcx81pxSHBDTL5WXT3nyVjpVrwbOt+Th8xny8A4Wjb8JOLwdbEpJi/UVL03kw2ibSawWNwtdGHwgzdKNc+wsdBBl5xekIGfWX1zL9cL/Tj+gYQRxp/SmiMpLEeCn6d4f9iM4Ri1PGNSUlRNU4ayz9z50rSZmXIv4D5GbjnaG0Xq2ugM6/8aKUsLqYWdF764AfHWb8zavs+Kj76vX+6+7Rq+ODbnyYJd2D5Pfjw+z4mGf8uH0z7ry2ZVT+stva25bevApoo6E1DvbNplE3EqEy7TNaV3qVZs8GNtT3YO/gqPemt38Pje/52LeE9dZhBSW753kJqTXxoEd0EyqjHKTUf4z00lJPaMIm7gjAo2OjRO8HN6giwINKbU/6/ZFweRX3kO/6DRX91VMsddxHU6p/MTg7/3B97uFAkCy4aihfopIFVLL2W8fGvn3gAjLA0cE318fZUyiKx/s9q3dB83ISN5tXhA9UyZx2CwrMZtSTPxk5n9NrhK6hUzY+3nE86/qzJJ6ycQEOA4hy2jpjQJHoLHjYvSE3SFxWvpSbLDPvLFac4vmxdA/K3jY29OXHa6pEXN+lFp5FMIqJj4UgT93FZ8zvVf9uFkmuRhUfkWzQOa9PpM2RJWzZzuKBolqwt5o2PMT0eIkbPQaFKerUoTj6j+6i8h8WWOVT
|
|
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={"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>
|
|
|