POST /user-management/remote/test
This resource is used to test a radius server connection.
You need to add the radius server information with the password and user name.
You will receive an Http error code 401 Unauthorized if the test failed otherwise you will get a 200 Success.
All fields are required.
FROM API REVISION 2.0
You will always receive a response 200 OK with a success
response into the body to indicate if the test succeed or not.
If a server error occured an error 500 Internal Error is displayed or 422 Unprocessable Entity if the data is invalid.
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: Remote
Property Name | Type | Description | Method |
---|---|---|---|
IpAddress | String | The IP address of the remote RADIUS server. | POST |
AuthenticationPort | Integer | This is the port on which authentication requests are made. | POST |
AccountingPort | Integer | This is the port on which accounting requests are made. | POST |
ProxyPort | Integer | This is an internal port used to proxy requests between a local server and a remote server. | POST |
SharedKey | String | This is an encryption key that devices use to encrypt and decrypt user authentication credentials that are sent between devices. This property need to be send in Base64 |
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 |
URL Example: https://0.0.0.0/api/rest/v1/user-management/remote/test
{
"ipAddress": "172.16.8.15",
"authenticationPort": 1812,
"accountingPort": 1813,
"proxyPort": 1814,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=",
"usernameTest": "admin",
"passwordTest": "Qetivj78fD"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management/remote/test
<?xml version="1.0" encoding="utf-8"?>
<Remote>
<IpAddress>172.16.8.15</IpAddress>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1813</AccountingPort>
<ProxyPort>1814</ProxyPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
<UsernameTest>admin</UsernameTest>
<PasswordTest>admin</PasswordTest>
</Remote>