xID Connect is a Javascript helper library that offers simple integration of the xID service for OIDC Clients. xID Connect supports several combinations of integration methods and message flows, each with different user experiences and considerations. The chosen integration method may cause a window, redirect, iframe or inline dialog to appear showing any dialogs relevant for the xID session. Depending on the chosen protocol flow, HTTP endpoints at the back-end of the OIDC Client must be implemented to perform appropriate Token and Userinfo requests to retrieve data about the authenticated user.
...
| Parameter | Description | Default |
|---|---|---|
client_id | A string specifying the ID given when registering the OIDC Client in question with the OIDC Provider fromBankID. | |
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' |
method | The chosen xID Connect integration method as further described below. | 'window' |
response_type | The chosen authentication response type governing protocol govern message flow as further describe below. | 'code' |
...
| Method | Description |
|---|---|
window | A popular (and default) implementation choice is window. When xID Connect is triggered it will open the OIDC session in a new window (pop-up). Note that an user action should trigger this session as otherwise pop-up blockers might block the window. |
inline | A DOM element ID can be provided to There is also a special integration which will display a modal dialogue overlaying your application. This method is useful when triggering xID Connect upon loading the application to avoid pop-up blockers. This method is described here XXXX. |
(not fully tested) | xID Connect can redirect the user away from your application to a separate web page for the entire xID login session before returning to a given callback URL. When using this method its important to set redirect_uri to point to a HTTP endpoint on the OIDC Client back-end which can receive authorisation code / tokens. |
Anchor Protocol-flow Protocol-flow
| Protocol-flow | |
| Protocol-flow |
...
Message flows (response_type)
xID Connect supports each of the protocol flows supported by the OIDC Provider as governed by the response_type parameter
...