POST /user-management-v2/client/oidc
FROM API REVISION 6.0
On this resource, you can retrieve the OIDC client configuration.
When the OIDC client configuration is enabled, the controller will use the OIDC server for authentication.
<span class="glyphicon glyphicon-warning-sign small-warning" aria-hidden="true"> The OIDC client can be enabled only if :
If you want to apply your configuration in one request, you can use the query-parameter force=true, that will disabled the Http protocol if this one is enable and deactivate the user-management server.
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: 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 |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc
{
"recoveryPasswordExists": false,
"httpsPort": 443,
"enabled": false,
"accessToken": "RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==",
"ipAddress": "10.59.82.67"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc
{
"recoveryPasswordExists": false,
"httpsPort": 443,
"enabled": false,
"accessToken": "RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==",
"ipAddress": "10.59.82.67"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc
<?xml version="1.0" encoding="utf-8"?>
<OidcTest>
<Enabled>true</Enabled>
<IpAddress>1.1.1.1</IpAddress>
<HttpsPort>443</HttpsPort>
<AccessToken>RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==</AccessToken>
</OidcTest>
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc
<?xml version="1.0" encoding="utf-8"?>
<OidcTest>
<Enabled>true</Enabled>
<IpAddress>1.1.1.1</IpAddress>
<HttpsPort>443</HttpsPort>
<AccessToken>RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==</AccessToken>
</OidcTest>