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

579 lines
24 KiB
Plaintext

---
id: providers-radius-update
title: "providers_radius_update"
description: "RadiusProvider Viewset"
sidebar_label: "providers_radius_update"
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/RVCL9sCvrRJmnbztNk0WwRI2yBJuw9FYNDSyGJNkSpJ2XUN/XtnSMmWHTkXbHf7sH0wIEvkXM4cHg65jHQBhjuh1VkSHUWF0TORgLEjwxNR2lFZJNxB1IsSsLERBY3EcZf+60U9mn0UMLfgcFjBDc/BoYXo6NMyEjS44C7DTwo/4D+R4LONM8h5dLSM3KLwb5WDCZio2vZ0zEolvpTA6hFsxiX9S0A5kS6EmjCXCctCRKwJaYBODHwphQHMy5kSqpte5PiE4lqnGd2EYWDdnzpZUECxRkfK0SMvCilij87ws6Vwlrcj1+PPELv7ELoCI7gU3zDFHrlH1J0AS3YCLit71hlMCkflQp2DmiB2R88RFl66jHIO8YxSqedds1Jtco7RR2XpkVallHwsIYCwHeVfaIWVFhKG89imCzbHPwguMG6tjgXyIGEtSBiizuMYLE0fLxhXWKp+ywa+RtNYijp6bcS3xwW/K1gfWWNyRYFiVftqhfFilGPIOMS2/HFj+ALNCwe5vT+OCs3FUmBWIwVurs20c1K7XtuhnwvrmE7ZydnrS8uexDrPed8CrRaE6SnGzx0LPiyLEUlkoUJasdTofMCOWa4NMFtALFIRezNsLqRkGGacsTGk9J0zqTUizrSCATtpzAVTBBNZw1FKq35tC8FcGxsDSxC2AhIPoc04rp6RhdiAe2zGV34yC5PRspsD1qxJkSv6ZGYYq9Ms4zZjBY+n4Kz3nKd8ZMui0Kbtd6y1BK5u8eJvYgMoYnnSw3QT6I850SQvpRP9lMfuNrkJZMy3bMiLWauEMOIYWC5iLXEQhUkL4Pr99YU3TNHSiwKXBBIhGbBrYp7NdCkThF0uyGgdCxMp4wgrLQIbShxgFmRWb5IWQZhRBb2rBGYiBqpcKialobS4ZRo9m7mwNKwJAAmwQGmMtTFY4+DeAClS8C8cWXFcKNvObOBJvRbIT10LtJZs0k3hSEG2RO0yCCeaqm6JLbIH4tIIt/D7QAP+FP/dVF50baGVDQq49+zZT1HeYtqxA1FsPHmPpWwks8n+7DVxs1uufwn0zxZonSOhavpsD98M8w0KUuAOW81iVtcrFNhUYRoZ/nCNQoIriCBekW2THYSctWKiUChb0I+sLCf3R3KGnDOKy42qEcF6AUah2IfLczt4sNtdvcRWT7We8ZtlibCFRBV5h3Pv9jRGiY4zjtuJ/FnJ7grhX0kct6cx7qcPNH4JrjSqJgqa35h9j/VRIUvD5eOdhHn3+sKWnI9y3MDk45IRTc38XLbL/AO6o/9DP/QDOyBdukJbN7Ibnu7Rxaqr8r9aqf+8ldqpzHdtFg8VuYfqceeW3t4nb6tC3dxssq9HbdKWFnaL185GMXSIm0wjsh780L7vI3Z5SWDkqTG646BNKAiQyQjo+yMajtBgJF19H21OCTYJ6JbLi7a/ag3HOrQQ2U489n8gHm9AYesbs+OLsx2AJFh/0bHp3Jltm+m1gVbha6d3pBl2o0z766Yy3BnRCTIarm5lhuHyabgUSTWk2yKvk+FGqTSSxvJCDGf7w4jOEs1J44qACZm1zhurHDLniubqyWsgoD4bHxBBe7m+Bjr9yvNCwvpyZi3xnU1+tJ/yVy/Sw4P+i5fPX/YPXhzu9cf7adzfi38/3E8PD3nKD7sX5IPndrTLnx4296Zjf14ntLWptQ737Y2j3kyESrVHtK72GmavCDbUeO/Z3sHg1WDvFiPf8qnfFja3DysI7IHXJpTX2BMfGU7MjDKQUv8x0StPA6GJn7gqAI+PrRK9PbtGE4EeVGp7NBxOhMvK8QA1b9gyMVw/jaUeD9GVGp6fnZy+uzr1dCDty7lqGV9RkwVqsu570dba3X1FWtPRwVc3xP5TKMrHx72sl0L7ghIXnDeED0f+yEX1zDBAGrZc0u78wciqotdIYEPnbXyccTz1+lMlrhlsdP0uGh2lXNrtM2Y76CeX9ep+yv7BxWtnho3SKtJZb4vkoBdNYRFuhasbHJVh/4KLkqIOH05CbP1rmr6eeEsYq14z4xiPvIW7c+xNS4MuPhBvxvXtb+51DzGfe+TnIUbtofLK4t8tI8nVpOQTGhtMVvUZut1kBYHpNQ+UVCcKWEY/4lpPQWEpG1Ac/Sdcquo7ui5ZXA==
sidebar_class_name: "put 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_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/providers/radius/{id}/"}
>
</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"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this Radius Provider.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><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={"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={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>