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 | A string specifying the client ID given when registering to the OIDC central service. | Yes | |
redirect_uri | Absolute URL to the HTTP(S) endpoint receiving the authentication response from OIDC. Read more about how the Connector can help with window/inline management. | Yes | |
oauth_url | Absolute URL to the OIDC Authorize endpoint. | (standarddefault authorize endpoint)Yes, but default value is shipped | 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 | A string of resource types (dataset) belonging to the user to request access to. Each scope / resource type must be separated by space. | '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 | The chosen authentication response type, explained here. Ex. | 'code' | No |
response_mode | Set the format used when returning parameters from the Authorization Endpoint via | 'query' | No |
user_profile | Set the use of any particularly named Identity Provider along with any pre-configuration for the designated provider. Read more about the login_hint parameter. | '' | No |
state | Increase security towards cross-site request forgery by verifying this value in the requests and responses | 'untouched' | No |
nonce | Provide a nonce value for securing the integrity of the id_token | '' | No |
ui_locales | Provide the desired locale for the session (nb: Norwegian Bokmål, en: English) | 'nb' | No |
Warning |
---|
For increased security in a production environment, it is highly encouraged to use nonce and state parameters when interacting with the OIDC service. |
...
Parameter | Description | Default | Required |
---|---|---|---|
callback | Function callback that is called when JS Connector receives XDM events as explained here. Arguments are:
| null | No |
config | An object with key-value pairs of configuration parameters can be given that can override any parameters given in doInit . | {} | No |
inlineOnLoadCallback | Specify a callback function that will attach to the onload event for the injected iframe when using inline method. | null | No |
inlineElementID | A string containing the ID of a DOM element that will have the OIDC login iframe injected into. | null | Required when using inline method |
OIDC.doGetUserInfo ( callback(err, user), [accessToken, tokenType, responseType] ) (experimental)
Function to handle response from userinfo call.
Arguments are:
- err - error messages, if any
- user - user object with data
null
null
token
if userInfo request should go directly to oauth endpoint instead of through the middleware.'code'
Events
The following custom events are relevant for the JS Connector.
Event for loading JS Connector
...