Radius Attributes | Parallels REST API

Parallels REST API

SupportDocumentation

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

objectOptional

The RADIUS attribute

application/json; api-version=1.0

get

GET /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Accept: */*

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

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

objectOptional

The RADIUS attribute

application/json; api-version=1.0

post

POST /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 149

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

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

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

delete

DELETE /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 149

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

No content