Class: OidcProvider

OidcProvider()

The Authentication Provider for OpenID Connect.

ToDo: Add how to use the OIDC Provider.

Constructor

new OidcProvider()

Source:

Extends

Methods

(static) setUiMethod(method)

Globally sets the UI method (redirect, popup) to use for OIDC authentication.

Parameters:
Name Type Description
method string

Method how to load and show the authentication process. Either popup (opens a popup window) or redirect (HTTP redirects, default).
Source:

(async, static) signinCallback(provider) → {User}

Finishes the OpenID Connect sign in (authentication) workflow - EXPERIMENTAL!

Must be called in the page that OpenID Connect redirects to after logging in.

Parameters:
Name Type Default Description
provider OidcProvider null

A OIDC provider to assign the user to.
Source:
Throws:

Error

Returns:

For uiMethod = 'redirect' only: OIDC User (to be assigned to the Connection via setUser if no provider has been specified).

Type
User

(async) login(client_id, redirect_uri, optionsopt)

Authenticate with OpenID Connect (OIDC) - EXPERIMENTAL!

Supported only in Browser environments.

Parameters:
Name Type Attributes Default Description
client_id string

Your client application's identifier as registered with the OIDC provider
redirect_uri string

The redirect URI of your client application to receive a response from the OIDC provider.
options object <optional>
 {}

Object with authentication options. See https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings for further options.
Source:
Throws:
Error

(async) logout()

Logout from the established session - EXPERIMENTAL!

Overrides:
Source:

setUser(user)

Sets the OIDC User.

Parameters:
Name Type Description
user User

The OIDC User returned by OidcProvider.signinCallback(). Passing null resets OIDC authentication details.
Source:
See: