Radius Attributes

PreviousRadius NextRadius Auto Info

Was this helpful?

Get Attribute

get

Retrieve a Radius Attribute List.

Path parameters

idinteger · int32required

The ID of a MFA for which to retrieve the Radius Attribute.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/MFA/{id}/RadiusAttr'

200

401

404

{
  "vendorID": 1,
  "attributeID": 1,
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ],
  "radiusAttrName": "text",
  "vendor": "text",
  "value": "text"
}

Success

Add Attribute

post

Add a new Radius Attribute.

Path parameters

idinteger · int32required

MFA settings

Body

Add MFA RADIUS attribute

vendorIDinteger · int32required

RADIUS attribute vendor ID

attributeIDinteger · int32required

RADIUS attribute ID

valuestring | nullablerequired

RADIUS attribute value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

radiusAttrNamestring | nullablerequired

RADIUS attribute name

vendorstring | nullablerequired

RADIUS attribute vendor name

attributeTypestring · enumrequired

RADIUS attribute type

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFA/{id}/RadiusAttr' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vendorID": 1,
    "attributeID": 1,
    "value": "text",
    "radiusAttrName": "text",
    "vendor": "text",
    "attributeType": [
      "0 = Number",
      "1 = String",
      "2 = IP",
      "3 = Time"
    ]
  }'

201

401

409

{
  "vendorID": 1,
  "attributeID": 1,
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ],
  "radiusAttrName": "text",
  "vendor": "text",
  "value": "text"
}

Created

Delete Attribute

delete

Delete a Radius Attribute from a site.

Path parameters

idinteger · int32required

The ID of a RadiusAttr to remove from the site.

Body

vendorIDinteger · int32required

RADIUS attribute vendor ID

attributeIDinteger · int32required

RADIUS attribute ID

valuestring | nullablerequired

RADIUS attribute value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

radiusAttrNamestring | nullablerequired

RADIUS attribute name

vendorstring | nullablerequired

RADIUS attribute vendor name

attributeTypestring · enumrequired

RADIUS attribute type

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/MFA/{id}/RadiusAttr' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vendorID": 1,
    "attributeID": 1,
    "value": "text",
    "radiusAttrName": "text",
    "vendor": "text",
    "attributeType": [
      "0 = Number",
      "1 = String",
      "2 = IP",
      "3 = Time"
    ]
  }'

204

401

404

No Content