Skip to content
Elysia OpenID Client

OIDCClientSettings

Plugin settings

Properties

callbackCompletedPath

callbackCompletedPath: string

Path or URL to redirect after callback is complete

Default

"/"

Example

"/path/to/app"

Defined in

src/types.ts:134

callbackPath

callbackPath: null | string

Path of callback endpoint

  • Method: GET
  • If set to null, the endpoint is disabled.

Default

"/callback"

Defined in

src/types.ts:158

claimsPath

claimsPath: null | string

Path of claims endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/claims"

Defined in

src/types.ts:214

introspectPath

introspectPath: null | string

Path of intropect endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/introspect"

Defined in

src/types.ts:186

loginExpiration

loginExpiration: number

Login expiration (ms)

Default

600000 (10 minutes)

Defined in

src/types.ts:220

loginPath

loginPath: null | string

Path of login endpoint

  • Method: GET
  • If set to null, the endpoint is disabled.

Default

"/login"

Defined in

src/types.ts:151

logoutCompletedPath

logoutCompletedPath: string

Path or URL to redirect after logout is complete

  • If it starts with / , merge it with baseUrl automatically.

Default

“/logout” (${baseUrl}/logout)

Examples

"/path/to/app/logout"
"https://example.com/logout"

Defined in

src/types.ts:142

logoutPath

logoutPath: null | string

Path of logout endpoint

  • Method: GET
  • If set to null, the endpoint is disabled.

Default

"/logout"

Defined in

src/types.ts:165

pathPrefix

pathPrefix: string

Path prefix

Default

"/auth"

Defined in

src/types.ts:144

pluginSeed?

optional pluginSeed: string

Plugin seed

Default

${issuerUrl}

Defined in

src/types.ts:231

refreshExpiration

refreshExpiration: number

Refresh expiration (ms)

Default

2592000000 (30 days)

Defined in

src/types.ts:225

refreshPath

refreshPath: null | string

Path of refresh endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/refresh"

Defined in

src/types.ts:179

resourcePath

resourcePath: string

Path of resource endpoint

  • Method: GET
  • Usage: /resource?url=<resource-url>

Default

"/resource"

Defined in

src/types.ts:200

revokePath

revokePath: null | string

Path of revoke endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/revoke"

Defined in

src/types.ts:193

statusPath

statusPath: null | string

Path of status endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/status"

Defined in

src/types.ts:207

userinfoPath

userinfoPath: null | string

Path of userinfo endpoint

  • Method: ALL
  • If set to null, the endpoint is disabled.

Default

"/userinfo"

Defined in

src/types.ts:172