Radius Auto Info | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Delete Auto Info

delete

Delete a Radius Auto Info from a site.

Path parameters

idinteger · int32required

The ID of a MFA to remove a RadiusAutoInfo from the site.

radiusautoidinteger · int32required

The ID of a RadiusAutoInfo to remove from the site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}'

204

401

404

No Content

Get Auto Info

get

Retrieve information about MFA Radius Auto Info List.

Path parameters

idinteger · int32required

The ID of a MFA for which to retrieve the MFA Radius Auto Info List.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "id": 1,
  "priority": 1,
  "autoSend": true,
  "command": "text",
  "enabled": true,
  "image": [
    "100 = Alert",
    "101 = Message",
    "102 = Email",
    "103 = Call",
    "104 = Chat",
    "105 = Flag"
  ],
  "description": "text",
  "actionMessage": "text",
  "title": "text"
}

Success

Add Auto Info

post

Add a new Radius Auto Info to a site.

Path parameters

idinteger · int32required

MFA settings

Body

Add a Gateway IP exclusion to Multi-factor authentication settings

commandstring | nullablerequired

RADIUS Automation command

enabledbooleanoptional

Whether the RADIUS Automation is enabled/disabled

imagestring · enumoptional

Image Type

Available options:

titlestring | nullablerequired

RADIUS Automation title

actionMessagestring | nullableoptional

RADIUS Automation action message

descriptionstring | nullableoptional

RADIUS Automation description

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/MFA/{id}/RadiusAutoInfo' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "command": "text",
    "enabled": true,
    "image": [
      "100 = Alert",
      "101 = Message",
      "102 = Email",
      "103 = Call",
      "104 = Chat",
      "105 = Flag"
    ],
    "title": "text",
    "actionMessage": "text",
    "description": "text"
  }'

201

401

409

{
  "id": 1,
  "priority": 1,
  "autoSend": true,
  "command": "text",
  "enabled": true,
  "image": [
    "100 = Alert",
    "101 = Message",
    "102 = Email",
    "103 = Call",
    "104 = Chat",
    "105 = Flag"
  ],
  "description": "text",
  "actionMessage": "text",
  "title": "text"
}

Created

Update Auto Info

put

Update Radius Auto Info from a site.

Path parameters

idinteger · int32required

The ID of a MFA to update a RadiusAutoInfo from the site.

radiusautoidinteger · int32required

The ID of a RadiusAutoInfo to update.

Body

autoSendboolean | nullableoptional

Whether the RADIUS Automation autoSend is enabled or not

commandstring | nullableoptional

RADIUS Automation command

enabledboolean | nullableoptional

Whether the RADIUS Automation is enabled/disabled

imagestring · enumoptional

Image Type

Available options:

descriptionstring | nullableoptional

RADIUS Automation description

actionMessagestring | nullableoptional

RADIUS Automation action message

newTitlestring | nullableoptional

RADIUS Automation title

prioritystring · enumoptional

Move Direction.

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/MFA/{id}/RadiusAutoInfo/{radiusautoid}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "autoSend": true,
    "command": "text",
    "enabled": true,
    "image": [
      "100 = Alert",
      "101 = Message",
      "102 = Email",
      "103 = Call",
      "104 = Chat",
      "105 = Flag"
    ],
    "description": "text",
    "actionMessage": "text",
    "newTitle": "text",
    "priority": [
      "0 = Up",
      "1 = Down"
    ]
  }'

204

401

404

No Content