providers_radius_partial_update

PATCH 
/api/v3//providers/radius/:id/

RadiusProvider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this Radius Provider.

application/json

Body

namestring

Possible values: non-empty

authentication_flowuuidnullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowuuid

Flow used when authorizing this provider.

invalidation_flowuuid

Flow used ending the session from a provider.

property_mappingsuuid[]

client_networksstring

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.

Possible values: non-empty

shared_secretstring

Shared secret between clients and server to hash packets.

Possible values: non-empty

mfa_supportboolean

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.

Responses

200

application/json

Schema

Schema

pkID (integer)required

namestringrequired

authentication_flowuuidnullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowuuidrequired

Flow used when authorizing this provider.

invalidation_flowuuidrequired

Flow used ending the session from a provider.

property_mappingsuuid[]

componentstringrequired

Get object component so that we know how to edit the object

assigned_application_slugstringrequired

Internal application name, used in URLs.

assigned_application_namestringrequired

Application's display Name.

assigned_backchannel_application_slugstringrequired

Internal application name, used in URLs.

assigned_backchannel_application_namestringrequired

Application's display Name.

verbose_namestringrequired

Return object's verbose_name

verbose_name_pluralstringrequired

Return object's plural verbose_name

meta_model_namestringrequired

Return internal model name

client_networksstring

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.

shared_secretstring

Shared secret between clients and server to hash packets.

outpost_setstring[]required

mfa_supportboolean

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.

Example (auto)

{
  "pk": 0,
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "component": "string",
  "assigned_application_slug": "string",
  "assigned_application_name": "string",
  "assigned_backchannel_application_slug": "string",
  "assigned_backchannel_application_name": "string",
  "verbose_name": "string",
  "verbose_name_plural": "string",
  "meta_model_name": "string",
  "client_networks": "string",
  "shared_secret": "string",
  "outpost_set": [
    "string"
  ],
  "mfa_support": true
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/providers/radius/:id/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"invalidation_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"client_networks\": \"string\",\n  \"shared_secret\": \"string\",\n  \"mfa_support\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body

{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "client_networks": "string",
  "shared_secret": "string",
  "mfa_support": true
}