OidcClientConfig
Defined in: client/src/types.ts:60
Configuration for OidcClient, extending the core OidcConfig with client-specific options.
Extends
Section titled “Extends”Properties
Section titled “Properties”autoRefresh?
Section titled “autoRefresh?”
optionalautoRefresh?:boolean
Defined in: client/src/types.ts:64
Whether to proactively refresh the access token before it expires. Defaults to true.
autoRefreshInterval?
Section titled “autoRefreshInterval?”
optionalautoRefreshInterval?:number
Defined in: client/src/types.ts:66
Polling interval in seconds for the auto-refresh check. Defaults to 10.
clientId
Section titled “clientId”clientId:
string
Defined in: core/src/types.ts:11
OAuth 2.0 client identifier issued during registration (RFC 6749 Section 2.2).
Inherited from
Section titled “Inherited from”clientSecret?
Section titled “clientSecret?”
optionalclientSecret?:string
Defined in: core/src/types.ts:13
Client secret for confidential clients (RFC 6749 Section 2.3.1). Omit for public clients.
Inherited from
Section titled “Inherited from”expiryBuffer?
Section titled “expiryBuffer?”
optionalexpiryBuffer?:number
Defined in: core/src/types.ts:21
Buffer in seconds before token expiry to consider the token expired. Defaults to 30.
Inherited from
Section titled “Inherited from”fetchProfile?
Section titled “fetchProfile?”
optionalfetchProfile?:boolean
Defined in: client/src/types.ts:62
Whether to fetch the userinfo profile after token exchange. Defaults to true.
issuer
Section titled “issuer”issuer:
string
Defined in: core/src/types.ts:9
Issuer identifier URL (must match the discovery document’s issuer field).
Inherited from
Section titled “Inherited from”postLogoutRedirectUri?
Section titled “postLogoutRedirectUri?”
optionalpostLogoutRedirectUri?:string
Defined in: core/src/types.ts:19
URI to redirect to after logout (OpenID Connect RP-Initiated Logout 1.0).
Inherited from
Section titled “Inherited from”OidcConfig.postLogoutRedirectUri
redirectUri?
Section titled “redirectUri?”
optionalredirectUri?:string
Defined in: core/src/types.ts:15
Redirection URI for authorization code responses (RFC 6749 Section 3.1.2).
Inherited from
Section titled “Inherited from”scopes?
Section titled “scopes?”
optionalscopes?:string[]
Defined in: core/src/types.ts:17
OAuth 2.0 scopes to request. Defaults to ["openid"] if omitted.