Skip to Content

@authgear/nextjs


@authgear/nextjs / index / AuthgearConfig

Interface: AuthgearConfig

Defined in: src/types.ts:1 

Extended by

Properties

clientID

clientID: string

Defined in: src/types.ts:5 

OAuth client ID


cookieName?

optional cookieName: string

Defined in: src/types.ts:15 

Session cookie name. Defaults to “authgear.session”


endpoint

endpoint: string

Defined in: src/types.ts:3 

Authgear endpoint, e.g. “https://myapp.authgear.cloud 


isSSOEnabled?

optional isSSOEnabled: boolean

Defined in: src/types.ts:24 

Whether to enable SSO (Single Sign-On) with other apps on the same Authgear tenant. When true (default), Authgear silently reuses its server-side session if the user is already logged in, so users are not prompted for credentials again. Set to false to always show the login form (prompt=login), which is recommended for single-app deployments where silent sign-in feels unexpected to the user. Defaults to true.


postLogoutRedirectURI?

optional postLogoutRedirectURI: string

Defined in: src/types.ts:9 

Where to redirect after logout


redirectURI

redirectURI: string

Defined in: src/types.ts:7 

Redirect URI for OAuth callback, e.g. “http://localhost:3000/api/auth/callback 


scopes?

optional scopes: string[]

Defined in: src/types.ts:11 

OAuth scopes. Defaults to [“openid”, “offline_access”, “https://authgear.com/scopes/full-userinfo ”]


sessionSecret

sessionSecret: string

Defined in: src/types.ts:13 

Secret key for encrypting session cookie (min 32 chars)

Last updated on