The JS Connector consists of a set of methods and events along with a set of configuration parameters which are summarized below:
Table of Contents maxLevel 2
Methods
The JS Connector API has the following methods:
...
| Parameter | Description | Default | Required |
|---|---|---|---|
client_id | See parameter description in documentation of the Authorize endpoint. | Yes | |
redirect_uri | See parameter description in documentation of the Authorize endpoint. Read more about how the Connector can help with window/inline management. | Yes | |
oauth_url | Absolute URL to the OIDC Authorize endpoint. | (default authorize endpoint) | No. The OIDC Connector determines the correct URL value via the output from oidc_url |
oidc_url | Absolute URL to the OIDC Openid-configuration endpoint. | (default .well-known endpoint) | No. The OIDC Connector embeds the correct URL value |
scope | See parameter description in documentation of the Authorize endpoint. | 'openid' | No |
method | Specify the desired frame method, as explained here. How will the login dialogs be presented to the user? | 'redirect' | No |
response_type | See parameter description in documentation of the Authorize endpoint. | 'code' | No |
response_mode | See parameter description in documentation of the Authorize endpoint. | 'query' | No |
prompt | See parameter description in documentation of the Authorize endpoint. | '' | No |
acr | Corresponds to theacr_values parameter as described in documentation of the Authorize endpoint. | 4 | No |
userlogin_profilehint | Corresponds to thelogin_hint parameter described in documentation of the Authorize endpoint. | '' | No |
state | See parameter description in documentation of the Authorize endpoint. | 'untouched' | No |
nonce | See parameter description in documentation of the Authorize endpoint. | '' | No |
ui_locales | See parameter description in documentation of the Authorize endpoint. | 'nb' | No |
id_token_hint | See parameter description in documentation of the Authorize endpoint. | '' | No |
| sign_id | See parameter description in documentation of the Authorize endpoint. | '' | No |
| sign_txt | See parameter description in documentation of the Authorize endpoint. | '' | No |
The doInit() optionally returns a Promise object if Promise is supported by the browser.
| Warning |
|---|
For increased security in a production environment, it is highly encouraged to use nonce and state parameters when interacting with the OIDC service. |
...
The doConnect() method returns a reference to the window object if method=window and the iframe element if method=inline.
Events
The following custom events are relevant for the JS Connector.
Event for loading JS Connector
...