Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Config

Hierarchy

Index

Properties

Properties

clientID

clientID: string

The client id of your identity provider

Optional endpoints

endpoints: (string | RegExp)[]

The endpoints to secure for this provider.

Optional level

level: "error" | "warn" | "info" | "trace"

Determines the level of verbosity of the logs.

defaultvalue

'warn'

Optional name

name: string

The name associated with your provider

Optional queryParams

queryParams: (type: "login" | "logout") => {}

Add extra parameters to the given authentication request.

Type declaration

    • (type: "login" | "logout"): {}

    • Parameters

      • type: "login" | "logout"

      Returns {}

      • [key: string]: any

Optional redirectUrl

redirectUrl: string | RedirectUrl

URL the Provider will send the response back to.

Optional renewal

renewal: "auto" | "manual" | { buffer?: number; type?: "auto" | "manual" }

Determines whether token renewal should be handled automatically or manually.

defaultvalue

'auto'

Optional responseType

responseType: "id_token" | "id_token token" | "code"

Determines whether a authorization code (server) or id token (client) should be returned.

Optional routes

routes: boolean | (string | RegExp)[]

The routes to secure for this provider.

Optional scope

scope: string

A list of space-delimited claims used to determine what user information is provided and what access is given.

Optional storage

storage: "local" | "session" | "cookie"

The storage api to keep authenticate information stored in.

Due to a known issue in Edge we recommend utilizing the default storage type. https://github.com/AzureAD/azure-activedirectory-library-for-js/wiki/Known-issues-on-Edge

defaultvalue

'cookie' or 'session' if cookies aren't enabled.

Optional url

url: string

The url of the designated provider.

Optional validation

validation: boolean | ValidationOptions

Generated using TypeDoc