POST /user-management-v2/client/radius
FROM API REVISION 6.0
On this resource, you can retrieve the Radius client configuration.
When the Radius client configuration is enabled, the controller will use the Radius server for authentication.
<span class="glyphicon glyphicon-warning-sign small-warning" aria-hidden="true"> The Radius client can be enabled only if the Radius server is disabled.
If you want to apply your configuration in one request, you can use the query-parameter force=true that will fix the issue for you. But be careful, this can disable something you didn't wanted to.
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.
This query parameter is used to force the apply when there is conflict.
This will be mostly used with the OIDC configuration that needs to respect a few constraints to be applied.
If this parameter is set to true, it will enable or disable other functionalities that can conflict with the one that you are trying to apply.
Default value : false
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 |
| ProxyPort | Integer | This is an internal port used to proxy requests between a local server and a remote server. | GET POST |
| Enabled | Boolean | Set this to enable the current mode or not. If set to true this can produce an error according the current configuration. See the description of the resource for more details. |
GET 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
{
"accountingPort": 1820,
"authenticationPort": 1812,
"enabled": false,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=",
"proxyPort": 1814,
"ipAddress": "10.59.82.67"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/radius
<?xml version="1.0" encoding="utf-8"?>
<Radius>
<Enabled>false</Enabled>
<IpAddress>10.59.82.67</IpAddress>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1820</AccountingPort>
<ProxyPort>1814</ProxyPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
</Radius>