Radius Auto Info

PreviousRadius Attributes NextSafenet

Last updated 1 year ago

Was this helpful?

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

delete

DELETE /api/MFA/{id}/RadiusAutoInfo/{radiusautoid} HTTP/1.1
Host: 
Accept: */*

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

get

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

{
  "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"
}

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

Possible values:

titlestring | nullableRequired

RADIUS Automation title

actionMessagestring | nullableOptional

RADIUS Automation action message

descriptionstring | nullableOptional

RADIUS Automation description

Responses

post

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

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

{
  "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"
}

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

Possible values:

descriptionstring | nullableOptional

RADIUS Automation description

actionMessagestring | nullableOptional

RADIUS Automation action message

newTitlestring | nullableOptional

RADIUS Automation title

prioritystring · enumOptional

Move Direction.

Possible values:

Responses

put

PUT /api/MFA/{id}/RadiusAutoInfo/{radiusautoid} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 237

{
  "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"
  ]
}

No content