OpenID Connect Resource Node

The OpenID Connect Resource authenticates with a compatible OpenID Connect API.

Properties

Client ID

PropopenidConnectNode.clientID
Typestring
Defaultundefined

The OpenID Connect Client ID to use.

Client Secret

PropopenidConnectNode.clientSecret
Type({ ref: string } | undefined)
Defaultundefined

The OpenID Connect Client Secret to use.

Scope

PropopenidConnectNode.scope
Typestring
Defaultopenid email profile

The list of claims to request from the OpenID Connect Provider, space separated.

Discovery Domain

PropopenidConnectNode.discoveryDomain
Typestring
Defaultundefined

The OpenID Connect Discovery domain to use.

Issuer

PropopenidConnectNode.issuer
Typestring
Defaultundefined

The OpenID Connect issuer to use.

Auth URL

PropopenidConnectNode.authURL
Typestring
Defaultundefined

The OpenID Connect Auth URL to use.

Token URL

PropopenidConnectNode.tokenURL
Typestring
Defaultundefined

The OpenID Connect Token URL to use.

Certificates URL

PropopenidConnectNode.certsURL
Typestring
Defaultundefined

The OpenID Connect Certificates URL to use.

Userinfo URL

PropopenidConnectNode.userinfoURL
Typestring
Defaultundefined

The OpenID Connect Userinfo URL to use.

Device Authorization URL

PropopenidConnectNode.deviceAuthorizationURL
Typestring
Defaultundefined

The OpenID Connect Device Authorization URL to use.

Registration URL

PropopenidConnectNode.registrationURL
Typestring
Defaultundefined

The OpenID Connect Registration URL to use.

MFA Challenge URL

PropopenidConnectNode.mfaChallengeURL
Typestring
Defaultundefined

The OpenID Connect MFA Challenge URL to use.

Revocation URL

PropopenidConnectNode.revocationURL
Typestring
Defaultundefined

The OpenID Connect Revocation URL to use.

Callback Route Override

PropopenidConnectNode.route
Typestring
Defaultundefined

The route where the callback endpoint should be mounted, relative to the project's endpoints root URL. Supports all routes supported by express via path-to-regexp.

Event Handlers

On Callback

HandleropenidConnectNode.onCallback

The event handler to be called upon the successful completion of the authentication. This property can be used to chain function calls.

Actions

Start OpenID Connect authentication flow

Generates a redirect URL for the start of the OpenID Connect authentication flow.

ParameterTypeDefault
valuestring``