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

665 lines
29 KiB
Plaintext

---
id: providers-radius-list
title: "providers_radius_list"
description: "RadiusProvider Viewset"
sidebar_label: "providers_radius_list"
hide_title: true
hide_table_of_contents: true
api: eJzFWN1v2zYQ/1cIvWwDHLtI+zDkaUGbFQb6ESRp91AEAi2dLdYUqZJUXM/w/747UrKlSPJHu2EPQWzzePe77+NtIl2A4U5oNU2jq6gw+kmkYGxseCpKG0thXTSKUrCJEQXRIdWdP7utaNlnASsLRFZww3NweD+6+rKJBBF/K8Gs8UzhCX7lRSFF4iXGsbCqlBIPbZJBzqOrTeTWBZHNtJbAVbTdjgb4lC7TRvwdOM2lXsWxleUCmcJ3nrg+ptYZoRbDPBMpQLlYgVtps7Q/w4r+nXq/uqINGpN+HEUGvpXCAHpkzqWFUVtE2xl/ZSLJ2FyATJnTrLTAVhkoVrNjLgNmwJbS2fGJUAq+gDNhXDO6xFSZzzAkVsJlQnnR+LNQ3EFagWAYKr04hHKwANMBElvx97loPgQYel5rTqYx4EqjGAa8x3oyCAvcJNnZ9gjXGGZDftjuj6PI8QWlzD7/IvzRQlIa4dY+lyjeMTjFEr890hVUrNDKgiWWly9e0L9EI3zl6GMjzyZfLUHadCHo2Vfw8Yly0SxOBG6Vy0S4dZhWwXfXoAr+j7ZEBk9Cl7b3MNGl6r+GKhsYOHPacRmT7/q5WseNi4VK4XvvOah08HTbdO+XoFZDiRryHmAbTlt4UxR5VzhJsm73dvXifGQ2sHBjOEWScJDbPtMfLMP3mO5cYq6YrkOXPSFOCHj6UUkMMGdK2OOcviF8Ifo74TrahWKyr71dulE01ybn6MioLEVKlRFLPZ+RgCCtrcyfyIWKV8rwHmuLCAWNigm3VifCV5NGgDNhGU8SsHR9tmZcsVJdNHjgz8jajGv07cZxCvghsB5ZzTJUWwRTp/E4JIJ3xTrOETKSnOLxARxbnzo55n07RXbkbZhvwbEQO2x3i1mNGLljK2BLhWpk+IfFEVLhvIl3wdaODrKctWKhII2bPZx67nEkU4w5o7hseY0CbBTMiL3i0907359OE9sfnJ0ivL/xi2WpsIXka/YB7x6WNOPJMsm4UiD/L2WHIPwnij+BmWkLJzK/C300BAqyb90+wj0uZGm4PF9IuHdUFk6fPM51ilY7SxlR+8zfZUPsn02Ix9m/w/mZxpDX0zd3lv2KaZjzCws0KGNV+i2kYuBqWYKFC1u4ooSdG52P2TXiMcBsAYmYi8SzweFKIk7ucLiYwZzOOZMarYIDj4Ixe12zC6yoKhE3pFJaXVS8MA73zGbAUqxSBaS+YtmMYxuMcf7Akem4jveenAVy5OVWgEWxVoorOjLoOCozGbcZTl/JEmgaRVm6dIW2LrYtSUfq4rbP83Me27IotGkyqt8R3akZIYKifpSO0FIpXMw4JWeOPVlczHFs77Yh8g+aqqzbDBpMpWRejhrmItESiUhfqqMPHx9uPWNSOwzC1mLUpGP2QD3CZrrEkV2jDsS0wsLEnHH0CLUrWxVq7yGh0sCo0V7Qmk/kfC8qxUklAXL6XCxKQ2pxyzRKNithiawGgLGzxoBPNA4yiQviDVCeBfmC2oVyXCjb1GzcGZKGK/OhZnFqkTu1Hve29Gaf7FaFarhpR9+IxqRntbC/eDVGuvYMhhZ6ZqLGKL2f+LojIaRtRlQ2ArN22FLkv/rJWb/N8TOOjGkI7xtjdHd2VGRSel3GQOdnTC9hWkn7hkjqdClOHCiWy9umvO3eNntoAdmgPV7+i/Z4Cwrn6IRd304HDJJiMImeDnZQ22ZMVAwaUVAJPaBmaG2ZpiXNotq1uAy/THZPxklY2UzoLeLrbVjClEYSGS/E5OnlJNo2Hpb3ZJOgVON5uYOfOVfUD1dfS/FBWz2VhJprT1kpsL/uM8YG2JcvLl+Nfx9fdoz8ni992WyXVyvyQvoBxZefxPsSnUbGjjKQUv+x0DtJY6HJ5OhowFewj9TwXH8/fUAWQW1SwV5NJgvhsnI2xpowabCY7D/NpJ5NUJSavJu+vvlwf+PVpNqQc9VgvrM2C9ZmfQuyRjAO78oqIzt8aE5wOhP+TehRbyrfNtcBGEGeEX6gwMkQGBFsNtS1Phm53dLPYRVBXseRz/eT3apiCevB7dsTlyWEbBq+eXzfdgqb4RXbKbefbdUOXxl0ybkbs15PBUCNnd0Pgjl7b3YATbW2+0Ekp+7MjgCo13U/bI9ne7MD4naLub2sR/piRNgzfHlE0gwHRaxalBTh1nWSQNEMn067IC67avv25qEaMZpjZSiFo/oDca+bolo3eGOCeooHvQSFSVpDd/QdBWGx/wcK0kYJ
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={"providers_radius_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/providers/radius/"}
>
</MethodEndpoint>
RadiusProvider Viewset
<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"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"application__isnull","schema":{"type":"boolean"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"authorization_flow__slug__iexact","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"client_networks__iexact","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"name__iexact","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
>
</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"}}
>
<SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
pagination
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"next"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"previous"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"count"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"current"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"total_pages"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"start_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"end_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
results
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
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={"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><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pagination\": {\n \"next\": 0,\n \"previous\": 0,\n \"count\": 0,\n \"current\": 0,\n \"total_pages\": 0,\n \"start_index\": 0,\n \"end_index\": 0\n },\n \"results\": [\n {\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 }\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>