OidcSettings

@tsed/oidc-provider

Usage

import { OidcSettings } from "@tsed/oidc-provider";

See /packages/security/oidc-provider/src/types/domain/OidcSettings.ts.

Overview

interface OidcSettings extends Configuration {
    secureCookies?: boolean;
    path?: string;
    issuer?: string;
    jwksPath?: string;
    certificates?: JwksKeyParameters[];
    secureKey?: string[];
    proxy?: boolean;
    allowHttpLocalhost?: boolean;
    Accounts?: Type<OidcAccountsMethods>;
    Adapter?: Type<Adapter>;
    connectionName?: string;
    plugins?: TsED.OIDCPluginSettings;
    render?: {
        omitClientProps?: string[];
    };
}

secureCookies

secureCookies?: boolean;

force the secure cookie. By default, in dev mode it's disabled and in production it's enabled.

path

path?: string;

Path on which the oidc-provider instance is mounted.

issuer

issuer?: string;

Issuer URI. By default, Ts.ED create issuer with http://localhost😒

jwksPath

jwksPath?: string;

Path to store jwks keys.

certificates

certificates?: JwksKeyParameters[];

Generate jwks from given certificates

secureKey

secureKey?: string[];

Secure keys.

proxy

proxy?: boolean;

Enable proxy.

allowHttpLocalhost

allowHttpLocalhost?: boolean;

Allow redirect_uri on HTTP protocol and localhost domain.

Accounts

Accounts?: Type<OidcAccountsMethods>;

Injectable service to manage accounts.

Adapter

Adapter?: Type<Adapter>;

Injectable adapter to manage database connexion.

connectionName

connectionName?: string;

Use the connection name for the OIDCRedisAdapter.

plugins

plugins?: TsED.OIDCPluginSettings;

render

render?: {
     omitClientProps?: string[];
 };