RADIUS REST API
The Radius endpoint allows getting the RADIUS Front-End (RFE) configuration and its status.
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.
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 |
|
is RFE configuration stale |
|
Get a RFE Configuration
[GET] /Radius/{id}
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.