POST /user-management-v2/client
FROM API REVISION 6.0
This is the client configuration of the user-management.
Two modes can be configured :
Example :
{
\"oidc\": {
\"enabled\":false
},
\"radius\":{
\"enabled\":false
}
}
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.
Object Name: Oidc
Property Name | Type | Description | Method |
---|---|---|---|
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 |
AccessToken | String | Identifier used by the server that is handling the protected resource to lookup the associated authorization information. The access token is usually a long string made up of 16 to 132 random alphanumeric characters and symbols that would be difficult to guess. | GET POST |
HttpsPort | Integer | Server HTTPS port of the SSO server. By default, this port is set to 443. | GET POST |
RecoveryPasswordExists | Boolean | True if a recovery password is already registered ; False otherwise. | GET |
RecoveryPassword | String | Used to access the controller in recovery mode if ever the server is unavailable. The password needs to be encoded in Base64. Requirements :
|
POST |
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. During 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
{
"oidc": {
"recoveryPasswordExists": false,
"httpsPort": 443,
"enabled": true,
"accessToken": "RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==",
"ipAddress": "1.1.1.1"
},
"radius": {
"accountingPort": 1820,
"authenticationPort": 1812,
"enabled": false,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=",
"proxyPort": 1814,
"ipAddress": "1.1.1.1"
}
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client
<?xml version="1.0" encoding="utf-8"?>
<Client>
<Oidc>
<Enabled>true</Enabled>
<IpAddress>1.1.1.1</IpAddress>
<AccessToken>RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==</AccessToken>
<HttpsPort>443</HttpsPort>
<RecoveryPasswordExists>false</RecoveryPasswordExists>
</Oidc>
<Radius>
<Enabled>false</Enabled>
<IpAddress>1.1.1.1</IpAddress>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1820</AccountingPort>
<ProxyPort>1814</ProxyPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
</Radius>
</Client>