Skip to main content

Class: OIDCStrategyOptions

Defined in: auth/src/auth/OIDCStrategy.ts:103

Describes the configuration options that can be used to initialize OIDCStrategy.

Constructors​

Constructor​

new OIDCStrategyOptions(name, provider): OIDCStrategyOptions

Defined in: auth/src/auth/OIDCStrategy.ts:122

Parameters​

name​

string

provider​

OIDCProvider

Returns​

OIDCStrategyOptions

Properties​

name​

name: string = "oauth"

Defined in: auth/src/auth/OIDCStrategy.ts:105

The unique name of the auth strategy instance.

provider​

provider: OIDCProvider

Defined in: auth/src/auth/OIDCStrategy.ts:110

The configuration of the OIDC/OpenID provider.

Methods​

getUser()​

getUser(token, profile): Promise<JWTUser | undefined>

Defined in: auth/src/auth/OIDCStrategy.ts:118

Retrieves the user data for the given unique identifier after authentication has completed successfully. NOTE: You must override this function when using this strategy.

Parameters​

token​

string

The user's authenticated access token to the third-party provider.

profile​

OIDCProfile

The user's profile data associated with the third-party provider.

Returns​

Promise<JWTUser | undefined>