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

575 lines
24 KiB
Plaintext

---
id: providers-radius-partial-update
title: "providers_radius_partial_update"
description: "RadiusProvider Viewset"
sidebar_label: "providers_radius_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWEtv2zgQ/iuELtsCfrRJmnZz2mya7QZI2yBJu4ciMGhxZLGmSJWk4rqG//vOkJItO8oL290etgcDsjTPb4Yfh1wkpgTLvTT6RCQHSWnNtRRg3chyISs3Krn1kqtRVQruIeklAlxqZUkaKH8epM5qLfZRwsyBRzHU4wV4tJQcfFokkoRL7nP8pPED/pMCn12aQ8GTg0Xi52V4qz1MwCbLbU+HrNLySwWslmDXXNE/AdrLbC71hPlcOhYjYk1IA3Ri4UslLWB+3lawvOolnk8ornW6yVUUA+d/N2JOAaUGHWlPj7wslUwDSsPPjsJZ3IzcjD9D6u9D6AIswim/YYo9co/oewmO7ERcVvact5gUShVSn4KeIHYHzxEWXvmcco7xjDJlZl1ambEFx+iTqgpI60opPlYQQdiO8g+0wioHgqEe23TBZvgHwQXGnTOpxD4QrAUJQ9R5moIj9fGccY2l6rds4Gs0jaWoozdWfntc8LcFGyJrTK5aoFzVfrnCeD4qMGQUcS1/3Fo+R/PSQ+Huj2OJ5lIlMauRBj8zdtqp1K7Xduin0nlmMnZ08vrcsSepKQred0CrBWF6ivFzz6IPx1JEErtQY1uxzJpiwA5ZYSwwV0IqM5kGM2wmlWIYZpqzMWT0nTNlDCLOjIYBO2rMRVMEE1lDKW10v7aFYK6NjYEJhK0EESB0OcfVM3KQWvCPzfgiKLOojJb9DLBmTYpc0yd7jbF6w3LuclbydAreBc9FxkeuKktj237Hxijg+kZf/EXdAJq6XPQwXQH9Mac2KSrlZT/jqb/Z3AQy5ls1zYtZa0EYcQyskKlRKERh0gK4fH95FgxTtPSixCWBjSAG7JI6z+WmUgJhV3MyWsfCZMY4wkqLwMUSR5glmTWbTYsgXFMFgysB1zIFqlwmJ5WltLhjBj3bmXQk1gSADTBHakyNtVjj6N4CMVL0Lz1Z8Vxq185sEJraS0/EkJxRE4HYpKzzSIsoSKJYx8pKPw+s3kA5xX9Xy0ChrjTaRT7befbsh/BoOe3YTyg2Lt5jYRoCbJI+eU2d1k2+P+n2R9OtKbCh6vbZFt8M8w3SS+wdttJiztTrDdhUYxo5/nDFgcD1QBCvmm2zOwg55+REI+21oB85VU3uj+QEe85qrjaqRg3WizBKzT6cn7rBg93eNhlsTUhrjV8cE9KVCjnhHere7WmMhJvmHDcH9aOSvS2EfyVx3GzGuDs+0Pg5+MrqulHQ/Ib2PdZHpaosV493EvXu9YUDNh8VuB2pxyUjm5oFXXab+QfMOv+H6eY7zjOm8qVxfuQ2PN3Di8uuyv8cjP6LwWh9cvx0BzPftVk8lOQeysedW3p7n7zJCvVws9l9PRqTtriwm7yu1qPS5gyWhIFws9OoWfe+69z3Eac8ETvy2FrTcWwmFCQoMQL6/oiBIw4Yomvuo81J4JCAbrk6a/trjcvr0GJkt+Kx+x3xeAMaR9+UHZ6d3AKIwPrLjk3nzmzbnV4baBW+dnpHmnE3yo2I9zxpHu6A6ESYDFe3LMN4qTRcSLEc0u1PYMp4Q1RZRbK8lMPr3WFCp4nmrHFB0MTcWieOVRa592VzlRRYEJChbQiJwD1fX+scf+VFqWB92bIm+c4xP9nN+KsX2f5e/8XL5y/7ey/2d/rj3Szt76S/7u9m+/s84/vdS/LBuh0D86eH6V517NDrhLa2tdZhvb111NuJ1JkJiNb1XsMcOMHFKu8829kbvBrs3OjJt3waNobNDcRJAnsQ2AkJNg2tjz1OvZnkoJT5bWJWngbSUIfiugA8QLZK9PbkEk3E9qBSu4PhcCJ9Xo0HyHrDlonh+mmszHiIrvTw9OTo+N3FcWgHYr+C65bxVWuy2Jqsvu9k3fedrVV8+9Vn3ZYevvohTqJSU14h/kW9JNoXj7j0giF8OAiHL6prjoGS2GJB+/QHq5ZLeo2NbOnkjY/XHM+/4XyJawdH3rCfJgcZV277tNkO+sl5vc6fsn9wodqZYcO5mhg32CJi6CVTmMfb3uUVSuU4yeDipKjjh6MYW/+S1NeKNyhy2Ws0DvHwW/o7Za9abHR2eHn0J0qP63vdInAgoj4L2M9ilCaAFTgmvFskiutJxSckG40u6/N0e+CKVNNrHiitThywkEHi0kxBYzEbWDz9J2SWy78BfVxPEQ==
sidebar_class_name: "patch 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_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
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>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
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={false}
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>