RADIUS REST API

The Radius endpoint allows getting the RADIUS Front-End (RFE) configuration and its status.

Note: The API version supported by HID Authentication Service is 10.3.0.

To use the version-specific parameters/attributes, you must add api-version=N to the query parameter.

Previous versions of the API are also supported with the corresponding functionality. For details of the version updates, see SCIM API Revision History.

Method Details

HTTPS Method	Entity Action	Request URI	Description
GET	Read	/scim/{tenant}/v2/Radius/{id}	Get the configuration of a RADIUS server
GET	Read	/scim/{tenant}/v2/Radius/{id}/stale	Get the status of the a RADIUS server (configuration is stale or not stale)

Required Permissions

Function	Required Permissions
GET	Retrieve RFE Configuration
is RFE configuration stale	Retrieve RFE Configuration

Get a RFE Configuration

[GET] /Radius/{id}

Copy

Sample Request URI

[GET] /scim/{tenant}/v2/Radius/server.com.2016-01-01T00:00:00Z

Copy

Sample Response

{
  "gatePolicy":[
    {
      "pushConfiguration":{
      },
      "name":"IIS Web Access Agent",
      "notes":"ActivID Web Access Agent for IIS channel",
      "channelCode":{
        "allChannels":false,
        "code":"CH_IIS"
      },
      "type":1,
      "clientsAddresses":null,
      "userMapping":{
        "stripIPtenant":false,
        "stripNTtenant":false,
        "type":0
      },
      "challengeConfiguration":{
        "challengeKeyword":"challenge",
        "challengePrompt":"Challenge",
        "challengeResponseOOBPrompt":"Enter the password you just received",
        "challengeResponsePrompt":"Enter OTP"
      },
      "parameter":null
    },
    {
      "pushConfiguration":{
        "pushAuthenticationCode":"AT_PASA",
        "pushKeyword":"pushkeyword",
        "pushMessage":"Logon Request Message"
      },
      "name":"VPN Remote Access",
      "notes":"Default RADIUS channel",
      "channelCode":{
        "allChannels":false,
        "code":"CH_VPN"
      },
      "type":1,
      "clientsAddresses":[
        "10.78.112.25"
      ],
      "sharedSecret":"shared",
      "userMapping":{
        "stripIPtenant":false,
        "stripNTtenant":false,
        "type":0
      },
      "challengeConfiguration":{
        "challengeKeyword":"challenge",
        "challengePrompt":"Challenge",
        "challengeResponseOOBPrompt":"Enter the password you just received",
        "challengeResponsePrompt":"Enter OTP"
      },
      "parameter":null
    }
  ],
  "parameter":null,
  "radiusServer":null,
  "realmProxyPolicy":null,
  "requestFailurePolicy":null,
  "restartTimeOffsetInSeconds":15,
  "version":{
    "version":"2017-04-19T12:36:32Z"
  }
}

Is RFE Configuration Stale

[GET] /Radius/{id}/stale

Returns true or false.

Copy

Sample Request URI

[GET] /scim/{tenant}/v2/Radius/server.com.2016-01-01T00:00:00Z/stale

Copy

Sample Response

false