Skip to main content

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.

Body

    name string

    Possible values: non-empty

    authentication_flow uuidnullable

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

    authorization_flow uuid

    Flow used when authorizing this provider.

    property_mappings uuid[]
    client_networks string

    Possible values: non-empty

    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_secret string

    Possible values: non-empty

    Shared secret between clients and server to hash packets.

    mfa_support boolean

    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​

Schema

    pk ID (integer)required
    name stringrequired
    authentication_flow uuidnullable

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

    authorization_flow uuidrequired

    Flow used when authorizing this provider.

    property_mappings uuid[]
    component stringrequired

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

    assigned_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_application_name stringrequired

    Application's display Name.

    assigned_backchannel_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_name stringrequired

    Application's display Name.

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    client_networks string

    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_secret string

    Shared secret between clients and server to hash packets.

    outpost_set string[]required
    mfa_support boolean

    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.

curl -L -X PATCH '/api/v3/providers/radius/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "client_networks": "string",
  "shared_secret": "string",
  "mfa_support": true
}'
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body
{
  "name": "string",
  "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "client_networks": "string",
  "shared_secret": "string",
  "mfa_support": true
}