OIDCClientOptions

Options

Properties

authHookSettings?

optional authHookSettings: Partial<OIDCClientAuthHookSettings>

Auth Hook Settings

Defined in

src/types.ts:107

---

authParams?

optional authParams: AuthorizationParameters

Authorization Parameters

See

• Authentication Request Specifications
• openid-client document
• AuthorizationParameters type definition

Defined in

src/types.ts:90

---

baseUrl

baseUrl: string

Application base url

• No trailing slash

Example

"https://app.example.com"

Defined in

src/types.ts:63

---

clientMetadata

clientMetadata: ClientMetadata & object

Client Options

Type declaration

client_secret

client_secret: string

See

• Client Metadata Specifications
• openid-client document
• ClientMetadata type definition

Defined in

src/types.ts:79

---

cookieSettings?

optional cookieSettings: Partial<OIDCClientCookieSettings>

Cookie Settings

See

Type definition

Defined in

src/types.ts:102

---

dataAdapter?

optional dataAdapter: OIDCClientDataAdapter

Session Database

Default

SQLiteAdapter

Defined in

src/types.ts:113

---

issuerUrl

issuerUrl: string

OpenID Provider URL

• No trailing slash

Example

"https://issuer.example.com"

Defined in

src/types.ts:70

---

logger?

optional logger: null | OIDCClientLogger

Logger

• pino can be assigned directly.

Example

import pino from "pino";
const rp = new OidcClient.factory({ ..., logger: pino() });

Defined in

src/types.ts:124

---

settings?

optional settings: Partial<OIDCClientSettings>

Plugin Settings

See

Type definition

Defined in

src/types.ts:96