POST /user-management-v2/server/oidc
FROM API REVISION 6.0
On this resource, you can retrieve the OIDC server configuration.
Using the controller as an OIDC server, will allow you to use it as a server for the benefits of the Single Sign On.
<span class="glyphicon glyphicon-warning-sign small-warning" aria-hidden="true"> The OIDC server 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.
The Content-Length entity-header field indicates the size of the entity-body.
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 |
| 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 |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/server/oidc
{
"accessToken": "cVBKZ3pNS1p3enY2aEEzYkRkM1NUQQ==",
"enabled": false
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/server/oidc
<?xml version="1.0" encoding="utf-8"?>
<Oidc>
<Enabled>false</Enabled>
<AccessToken>cVBKZ3pNS1p3enY2aEEzYkRkM1NUQQ==</AccessToken>
</Oidc>