angular-simple-oidc/lib/config/models.d.ts

Angular Library implementing Open Id Connect specification. Code Flow, Refresh Tokens, Session Management, Discovery Document.

import { TokenValidationConfig } from 'angular-simple-oidc/core';
export declare const AUTH_CONFIG_REQUIRED_FIELDS: (keyof AuthConfig)[];
export interface AuthConfig {
    /** The URL to the OpenID Provider (OP).
     * Casing and ending slashes do not matter.
     * i.e: http://localhost/identity */
    openIDProviderUrl: string;
    /** The OIDC Client Id.
     * i.e: 'sample.client'. */
    clientId: string;
    /** The OIDC Client Secret (May be required for Code Flow).
     * Note that this is not really a secret so this value should
     * not be treated as one.
     * i.e: 'my.dummy.secret'. */
    clientSecret?: string;
    /** Space separated list of scopes to request when requesting access tokens.
     * i.e: 'openid profile'
     */
    scope?: string;
    /**
     * Name of the tokenCallbackPath. This is the Angular Route 'path'
     * that will be set as implicit flow redirect uri.
     */
    tokenCallbackRoute?: string;
    /** DANGER ZONE:
     * Allows to tweak token validation behaviour
     * WARNING: This may deviate from the OIDC spec.
     */
    tokenValidation?: TokenValidationConfig;
    /**
     * Relative from @openIDProviderUrl
     * The URL of the discovery document.
     */
    discoveryDocumentUrl?: string;
    /**
     * Ann APP_INITIALIZER is configured which triggers the
     * Authorization Callback whenever the route matches the
     * @tokenCallbackRoute
     * It can be disabled using this boolean.
     */
    enableAuthorizationCallbackAppInitializer?: boolean;
    /**
     * The URL of this app. It will be auto calculated
     * `${window.location.protocol}//${window.location.host}${window.location.pathname}`
     */
    baseUrl?: string;
    /**
     * The authentication context class reference parameters.
     */
    acrValues?: string;
}