POST /user-management-v2/server
FROM API REVISION 6.0
This is the server 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.
The Content-Length entity-header field indicates the size of the entity-body.
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 |
| 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 |
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[ his 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 |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/server
{
"radius": {
"accountingPort": 1813,
"authenticationPort": 1812,
"enabled": true,
"sharedKey": "NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c="
},
"oidc": {
"accessToken": "cVBKZ3pNS1p3enY2aEEzYkRkM1NUQQ==",
"enabled": false
}
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/server
<?xml version="1.0" encoding="utf-8"?>
<Server>
<Oidc>
<Enabled>true</Enabled>
<AccessToken>cVBKZ3pNS1p3enY2aEEzYkRkM1NUQQ==</AccessToken>
</Oidc>
<Radius>
<Enabled>false</Enabled>
<AuthenticationPort>1812</AuthenticationPort>
<AccountingPort>1813</AccountingPort>
<SharedKey>NV5AIXNLPEFoNEhvJTdfPTxBZEAzXUJRQiZMKkNnO1c=</SharedKey>
</Radius>
</Server>