POST /user-management-v2/client/oidc/test
FROM API REVISION 6.0
This resource is used to test an OIDC server connection. You need to add the OIDC server information.
Once this request executed, you will be able to know if the server is reachable or not, following the configuration you provided.
On the response, if the success property is true, that means the server is reachable.
There is multiple other information like the caCertificate and the certificate that can be send with the other properties when you want to apply the configuration. This can save you a few seconds on the process.
To execute a test, only the IpAddress, AccessToken and HttpsPort are required.
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 | Integer | 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: OidcTest
| Property Name | Type | Description | Method |
|---|---|---|---|
| Success | Boolean | This property is true if the test was a success, false otherwise. | |
| Certificate | String | This is the certificate recovered after the test. This value can be resend when the OIDC values are applied. | |
| CaCertificate | String | This is the certificate authority. This value can be resend when the OIDC values are applied. | |
| CertificateFrom | String | This is the authority who delivered the certificate. | |
| CertificateTo | String | This is the target which got the certificate. |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc/test
{
"ipAddress": "10.59.82.67",
"httpsPort": 443,
"accessToken": "RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw=="
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc/test
<?xml version="1.0" encoding="utf-8"?>
<Oidc>
<IpAddress>10.59.82.67</IpAddress>
<HttpsPort>443</HttpsPort>
<AccessToken>RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==</AccessToken>
</Oidc>
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc/test
{
"ipAddress": "10.59.82.67",
"httpsPort": 443,
"accessToken": "RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw=="
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/client/oidc/test
<?xml version="1.0" encoding="utf-8"?>
<Oidc>
<IpAddress>10.59.82.67</IpAddress>
<HttpsPort>443</HttpsPort>
<AccessToken>RFdkYlhkMDRBdzVmYVBhT0RFd3g4Zw==</AccessToken>
</Oidc>