OpenID Connect Resource Node

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

Properties

Client ID

PropclientID
Typestring

The OpenID Connect Client ID to use.

Client Secret

PropclientSecret
Type({ ref: string } | undefined)

The OpenID Connect Client Secret to use.

Scope

Propscope
Typestring
Defaultundefined

The list of claims to request from the provider, space separated.

Callback Route Override

Proproute
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.

Use as Sign-in Provider

PropisSignInProvider
Typeboolean
Default{{true}}

Whether this OpenID Connect resource can be used as a sign-in provider. Users may use this resource to authenticate with the application current user.

Display Name

PropdisplayName
Typestring

The human-readable name of the sign-in provider. This is used to display the name of the sign-in provider in the application.

Discovery Domain

PropdiscoveryDomain
Typestring

The OpenID Connect Discovery domain to use.

Issuer

Propissuer
Typestring

The OpenID Connect issuer to use.

Auth URL

PropauthURL
Typestring

The OpenID Connect Auth URL to use.

Token URL

ProptokenURL
Typestring

The OpenID Connect Token URL to use.

Certificates URL

PropcertsURL
Typestring

The OpenID Connect Certificates URL to use.

Userinfo URL

PropuserinfoURL
Typestring

The OpenID Connect Userinfo URL to use.

Device Authorization URL

PropdeviceAuthorizationURL
Typestring

The OpenID Connect Device Authorization URL to use.

Registration URL

PropregistrationURL
Typestring

The OpenID Connect Registration URL to use.

MFA Challenge URL

PropmfaChallengeURL
Typestring

The OpenID Connect MFA Challenge URL to use.

Revocation URL

ProprevocationURL
Typestring

The OpenID Connect Revocation URL to use.

Legacy OAuth 2 Compatibility

PropisLegacyOAuth2Compatible
Typeboolean
Default{{false}}

Whether or not to only assume the OAuth 2.0 flow, rather than the complete OpenID Connect flow.

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 authentication flow

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

ParameterTypeDefault

Revoke OIDC authorization

Revokes the OpenID Connect authorization flow.

ParameterTypeDefault

Get authentication session

Gets the authentication session for.

ParameterTypeDefault
pathstringundefined