Skip to Content
API ReferenceInterfacesInterface: AuthgearModuleRootOptions

@authgear/nestjs


@authgear/nestjs / AuthgearModuleRootOptions

Interface: AuthgearModuleRootOptions

Defined in: src/authgear.interfaces.ts:17 

Options accepted by AuthgearModule.forRoot().

Extends

Properties

clientID?

optional clientID: string

Defined in: src/authgear.interfaces.ts:9 

If set, the verifier also asserts the token’s client_id claim equals this.

Inherited from

AuthgearModuleOptions.clientID


clockToleranceSeconds?

optional clockToleranceSeconds: number

Defined in: src/authgear.interfaces.ts:13 

Leeway in seconds applied to exp/iat checks. Default 0.

Inherited from

AuthgearModuleOptions.clockToleranceSeconds


endpoint

endpoint: string

Defined in: src/authgear.interfaces.ts:7 

Authgear project endpoint, e.g. https://my-project.authgear.cloud 

Inherited from

AuthgearModuleOptions.endpoint


global?

optional global: boolean

Defined in: src/authgear.interfaces.ts:19 

Register AuthgearAuthGuard as a global APP_GUARD. Default false.


jwksCacheMaxAge?

optional jwksCacheMaxAge: number

Defined in: src/authgear.interfaces.ts:11 

JWKS cache max age in milliseconds (passed to jose).

Inherited from

AuthgearModuleOptions.jwksCacheMaxAge