GitHub Authentication Resource Node

The GitHub Authentication Resource authenticates with the GitHub OAuth 2 API.

Properties

Client ID

PropgithubAuthNode.clientID
Typestring
Defaultundefined

The OpenID Connect Client ID to use.

Client Secret

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

The OpenID Connect Client Secret to use.

Scope

PropgithubAuthNode.scope
Typestring
Defaultundefined

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

Callback Route Override

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

Use as Sign-in Provider

PropgithubAuthNode.isSignInProvider
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

PropgithubAuthNode.displayName
Typestring
Defaultundefined

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

Event Handlers

On Callback

HandlergithubAuthNode.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
pathstring``