Configuration

import { defineConfig } from "elysia-openid-client/config";

const options: OIDCClientOptions = defineConfig({
  // ...
});

const rp = await OidcClient.factory(options);

Minumum requirements

{
  issuerUrl: "https://issuer.example.com/",
  baseUrl: "https://your-service.example.com",
  clientMetadata: {
    client_id: "client-id",
    client_secret: "client-secret",
  },
}

Reference

interface OIDCClientOptions {
  issuerUrl: string;
  baseUrl: string;
  settings?: Partial<OIDCClientSettings>;
  authHookSettings?: Partial<OIDCClientAuthHookSettings>;
  cookieSettings?: Partial<OIDCClientCookieSettings>;
  dataAdapter?: OIDCClientDataAdapter;
  logger?: OIDCClientLogger | null;
  clientMetadata: ClientMetadata & {
      client_secret: string;
  };
  authParams?: AuthorizationParameters;
}

• OIDCClientOptions
  • issuerUrl
    • URL of the OpenID Provider
    • e.g. https://github.com
  • baseUrl
    • URL of your apps as OpenID Relying Party
    • e.g. https://your-service.example.com
• OIDCClientSettings
  • Settings about the client. Paths, durations, etc.
• OIDCClientAuthHookSettings
  • Settings about before handle hook for auth.
• OIDCClientCookieSettings
  • Settings about Cookie for session.
• OIDCClientDataAdapter
  • See Data Adapter page.
• OIDCClientLogger
  • See Logger page.
• ClientMetadata
  • See ClientMetadata type definition of openid-client.
  • See Client Metadata section in the OpenID Connect Dynamic Client Registration 1.0.
• AuthorizationParameters
  • See AuthorizationParameters type definition of openid-client.
  • See Authentication Request section in the OpenID Connect Core 1.0.