POST /user-management-v2/client/radius/test
FROM API REVISION 6.0
This resource is used to test a radius server connection. You need to add the radius server information with the password and user name.
Once this request executed, you will be able to know if the server is reachable or not, following the configuration you provided.
On the response, if the success property is true, that means the server is reachable.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: RadiusTest
| Property Name | Type | Description | Method |
|---|---|---|---|
| Success | Boolean | This property is true if the test was a success, false otherwise. |
Object Name: Radius
| Property Name | Type | Description | Method |
|---|---|---|---|
| AuthenticationPort | Integer | The RADIUS server authentication port number. | GET POST |
| AccountingPort | Integer | The RADIUS server accounting port number. | GET POST |
| SharedKey | String | This is an encryption key that devices use to encrypt and decrypt user authentication credentials that are sent between devices. The shared key should be a long string of up 32 alphanumeric characters and symbols that would be difficult to guess. For example, he^sg3iq6pg2+gqw@89hsm,wz[ This same key must be copied to the remote RADIUS client. The shared key, can't be less than 16 characters. Dunring a POST the shared key must be encoded in Base64. |
GET POST |
| UsernameTest | String | This is the user's name on which we want to tests the connection. | POST |
| PasswordTest | String | This is the user's password on which we want to tests the connection. | POST |
| IpAddress | String | IP address of the RADIUS/OIDC server. This can be the IP address of an ECY series controller that is set as the Server Radius or a suitably-configured RADIUS server on an EC-Net / EC-BOS station. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/radius/test
{
"ipAddress": "1.1.1.1",
"authenticationPort": 1812,
"accountingPort": 1820,
"proxyPort": 1814,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=",
"usernameTest": "boby",
"passwordTest": "Z2dnZ2dnZ2c="
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/radius/test
<?xml version="1.0" encoding="utf-8"?>
<Radius>
<IpAddress>1.1.1.1</IpAddress>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1820</AccountingPort>
<ProxyPort>1814</ProxyPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
<UsernameTest>boby</UsernameTest>
<PasswordTest>Z2dnZ2dnZ2c=</PasswordTest>
</Radius>
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/radius/test
{
"ipAddress": "1.1.1.1",
"authenticationPort": 1812,
"accountingPort": 1820,
"proxyPort": 1814,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=",
"usernameTest": "boby",
"passwordTest": "Z2dnZ2dnZ2c="
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/radius/test
<?xml version="1.0" encoding="utf-8"?>
<Radius>
<IpAddress>1.1.1.1</IpAddress>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1820</AccountingPort>
<ProxyPort>1814</ProxyPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
<UsernameTest>boby</UsernameTest>
<PasswordTest>Z2dnZ2dnZ2c=</PasswordTest>
</Radius>