msal

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"Configuration" | msal</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">msal</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="_configuration_.html">"Configuration"</a> </li> </ul> <h1>External module "Configuration"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#authoptions" class="tsd-kind-icon">Auth<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#cachelocation" class="tsd-kind-icon">Cache<wbr>Location</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#cacheoptions" class="tsd-kind-icon">Cache<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#configuration" class="tsd-kind-icon">Configuration</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#frameworkoptions" class="tsd-kind-icon">Framework<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#systemoptions" class="tsd-kind-icon">System<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_configuration_.html#telemetryoptions" class="tsd-kind-icon">Telemetry<wbr>Options</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#frame_timeout" class="tsd-kind-icon">FRAME_<wbr>TIMEOUT</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#navigate_frame_wait" class="tsd-kind-icon">NAVIGATE_<wbr>FRAME_<wbr>WAIT</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#offset" class="tsd-kind-icon">OFFSET</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_configuration_.html#buildconfiguration" class="tsd-kind-icon">build<wbr>Configuration</a></li> </ul> </section> <section class="tsd-index-section tsd-is-not-exported"> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#default_auth_options" class="tsd-kind-icon">DEFAULT_<wbr>AUTH_<wbr>OPTIONS</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#default_cache_options" class="tsd-kind-icon">DEFAULT_<wbr>CACHE_<wbr>OPTIONS</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#default_framework_options" class="tsd-kind-icon">DEFAULT_<wbr>FRAMEWORK_<wbr>OPTIONS</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="_configuration_.html#default_system_options" class="tsd-kind-icon">DEFAULT_<wbr>SYSTEM_<wbr>OPTIONS</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="authoptions" class="tsd-anchor"></a> <h3>Auth<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Auth<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:34</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>type</dt> <dd><p>AuthOptions: Use this to configure the auth options in the Configuration object</p> <ul> <li>clientId - Client ID of your app registered with our Application registration portal : <a href="https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview">https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview</a> in Microsoft Identity Platform</li> <li>authority - You can configure a specific authority, defaults to " " or "<a href="https://login.microsoftonline.com/common"">https://login.microsoftonline.com/common"</a></li> <li>validateAuthority - Used to turn authority validation on/off. When set to true (default), MSAL will compare the application's authority against well-known URLs templates representing well-formed authorities. It is useful when the authority is obtained at run time to prevent MSAL from displaying authentication prompts from malicious pages.</li> <li>redirectUri - The redirect URI of the application, this should be same as the value in the application registration portal.Defaults to <code>window.location.href</code>.</li> <li>postLogoutRedirectUri - Used to redirect the user to this location after logout. Defaults to <code>window.location.href</code>.</li> <li>navigateToLoginRequestUrl - Used to turn off default navigation to start page after login. Default is true. This is used only for redirect flows.</li> </ul> </dd> </dl> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> authority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>client<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> navigate<wbr>ToLogin<wbr>Request<wbr>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr>Logout<wbr>Redirect<wbr>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> redirect<wbr>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> validate<wbr>Authority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="cachelocation" class="tsd-anchor"></a> <h3>Cache<wbr>Location</h3> <div class="tsd-signature tsd-kind-icon">Cache<wbr>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"localStorage"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sessionStorage"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:13</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cache location options supported by MSAL are:</p> <ul> <li>local storage: MSAL uses browsers local storage to store its cache</li> <li>session storage: MSAL uses the browsers session storage to store its cache</li> </ul> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="cacheoptions" class="tsd-anchor"></a> <h3>Cache<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Cache<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:49</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Use this to configure the below cache configuration options:</p> </div> <ul> <li>cacheLocation - Used to specify the cacheLocation user wants to set. Valid values are "localStorage" and "sessionStorage"</li> <li>storeAuthStateInCookie - If set, MSAL store's the auth request state required for validation of the auth flows in the browser cookies. By default this flag is set to false.</li> </ul> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> cache<wbr>Location<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#cachelocation" class="tsd-signature-type">CacheLocation</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> store<wbr>Auth<wbr>State<wbr>InCookie<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="configuration" class="tsd-anchor"></a> <h3>Configuration</h3> <div class="tsd-signature tsd-kind-icon">Configuration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:106</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Use the configuration object to configure MSAL and initialize the UserAgentApplication.</p> </div> <p>This object allows you to configure important elements of MSAL functionality:</p> <ul> <li>auth: this is where you configure auth elements like clientID, authority used for authenticating against the Microsoft Identity Platform</li> <li>cache: this is where you configure cache location and whether to store cache in cookies</li> <li>system: this is where you can configure the logger, frame timeout etc.</li> <li>framework: this is where you can configure the running mode of angular. More to come here soon.</li> </ul> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>auth<span class="tsd-signature-symbol">: </span><a href="_configuration_.html#authoptions" class="tsd-signature-type">AuthOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> cache<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#cacheoptions" class="tsd-signature-type">CacheOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> framework<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#frameworkoptions" class="tsd-signature-type">FrameworkOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> system<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#systemoptions" class="tsd-signature-type">SystemOptions</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="frameworkoptions" class="tsd-anchor"></a> <h3>Framework<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Framework<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:91</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>App/Framework specific environment support</p> </div> <ul> <li>isAngular - flag set to determine if it is Angular Framework. MSAL uses this to broadcast tokens. More to come here: detangle this dependency from core.</li> <li>unprotectedResources - Array of URI's which are unprotected resources. MSAL will not attach a token to outgoing requests that have these URI. Defaults to 'null'.</li> <li>protectedResourceMap - This is mapping of resources to scopes used by MSAL for automatically attaching access tokens in web API calls.A single access token is obtained for the resource. So you can map a specific resource path as follows: {"<a href="https://graph.microsoft.com/v1.0/me"">https://graph.microsoft.com/v1.0/me"</a>, ["user.read"]}, or the app URL of the resource as: {"<a href="https://graph.microsoft.com/"">https://graph.microsoft.com/"</a>, ["user.read", "mail.send"]}. This is required for CORS calls.</li> </ul> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Angular<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> protected<wbr>Resource<wbr>Map<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> unprotected<wbr>Resources<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="systemoptions" class="tsd-anchor"></a> <h3>System<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">System<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:75</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Library Specific Options</p> </div> <ul> <li>logger - Used to initialize the Logger object; TODO: Expand on logger details or link to the documentation on logger</li> <li>loadFrameTimeout - maximum time the library should wait for a frame to load</li> <li>tokenRenewalOffsetSeconds - sets the window of offset needed to renew the token before expiry</li> <li>navigateFrameWait - sets the wait time for hidden iFrame navigation</li> </ul> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> load<wbr>Frame<wbr>Timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> logger<span class="tsd-signature-symbol">?: </span><a href="../classes/_logger_.logger.html" class="tsd-signature-type">Logger</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> navigate<wbr>Frame<wbr>Wait<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> telemetry<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#telemetryoptions" class="tsd-signature-type">TelemetryOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> token<wbr>Renewal<wbr>Offset<wbr>Seconds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="telemetryoptions" class="tsd-anchor"></a> <h3>Telemetry<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Telemetry<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:60</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Telemetry Config Options</p> <ul> <li>applicationName - Name of the consuming apps application</li> <li>applicationVersion - Verison of the consuming application</li> <li>telemetryEmitter - Function where telemetry events are flushed to</li> </ul> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>application<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>application<wbr>Version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>telemetry<wbr>Emitter<span class="tsd-signature-symbol">: </span><a href="_telemetry_telemetrytypes_.html#telemetryemitter" class="tsd-signature-type">TelemetryEmitter</a></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a name="frame_timeout" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> FRAME_<wbr>TIMEOUT</h3> <div class="tsd-signature tsd-kind-icon">FRAME_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6000</span><span class="tsd-signature-symbol"> = 6000</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:18</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Defaults for the Configuration Options</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a name="navigate_frame_wait" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> NAVIGATE_<wbr>FRAME_<wbr>WAIT</h3> <div class="tsd-signature tsd-kind-icon">NAVIGATE_<wbr>FRAME_<wbr>WAIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">500</span><span class="tsd-signature-symbol"> = 500</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:20</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a name="offset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> OFFSET</h3> <div class="tsd-signature tsd-kind-icon">OFFSET<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">300</span><span class="tsd-signature-symbol"> = 300</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:19</li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="buildconfiguration" class="tsd-anchor"></a> <h3>build<wbr>Configuration</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">build<wbr>Configuration<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_configuration_.html#configuration" class="tsd-signature-type">Configuration</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:151</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>MSAL function that sets the default options when not explicitly configured from app developer</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>auth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> authority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>client<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> navigate<wbr>ToLogin<wbr>Request<wbr>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr>Logout<wbr>Redirect<wbr>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> redirect<wbr>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> validate<wbr>Authority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>cache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> cache<wbr>Location<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#cachelocation" class="tsd-signature-type">CacheLocation</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> store<wbr>Auth<wbr>State<wbr>InCookie<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>framework<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Angular<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> protected<wbr>Resource<wbr>Map<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> unprotected<wbr>Resources<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>system<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> load<wbr>Frame<wbr>Timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> logger<span class="tsd-signature-symbol">?: </span><a href="../classes/_logger_.logger.html" class="tsd-signature-type">Logger</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> navigate<wbr>Frame<wbr>Wait<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> telemetry<span class="tsd-signature-symbol">?: </span><a href="_configuration_.html#telemetryoptions" class="tsd-signature-type">TelemetryOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> token<wbr>Renewal<wbr>Offset<wbr>Seconds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_configuration_.html#configuration" class="tsd-signature-type">Configuration</a></h4> <p>TConfiguration object</p> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a name="default_auth_options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>AUTH_<wbr>OPTIONS</h3> <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>AUTH_<wbr>OPTIONS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:113</li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.authority-1" class="tsd-anchor"></a> <h3>authority</h3> <div class="tsd-signature tsd-kind-icon">authority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:115</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.clientid-1" class="tsd-anchor"></a> <h3>client<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:114</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.navigatetologinrequesturl-1" class="tsd-anchor"></a> <h3>navigate<wbr>ToLogin<wbr>Request<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">navigate<wbr>ToLogin<wbr>Request<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:119</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.validateauthority-1" class="tsd-anchor"></a> <h3>validate<wbr>Authority</h3> <div class="tsd-signature tsd-kind-icon">validate<wbr>Authority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:116</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.postlogoutredirecturi-1" class="tsd-anchor"></a> <h3>post<wbr>Logout<wbr>Redirect<wbr>Uri</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">post<wbr>Logout<wbr>Redirect<wbr>Uri<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:118</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_auth_options.redirecturi-1" class="tsd-anchor"></a> <h3>redirect<wbr>Uri</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">redirect<wbr>Uri<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:117</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a name="default_cache_options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>CACHE_<wbr>OPTIONS</h3> <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>CACHE_<wbr>OPTIONS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:122</li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_cache_options.cachelocation-2" class="tsd-anchor"></a> <h3>cache<wbr>Location</h3> <div class="tsd-signature tsd-kind-icon">cache<wbr>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sessionStorage"</span><span class="tsd-signature-symbol"> = "sessionStorage"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:123</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_cache_options.storeauthstateincookie-1" class="tsd-anchor"></a> <h3>store<wbr>Auth<wbr>State<wbr>InCookie</h3> <div class="tsd-signature tsd-kind-icon">store<wbr>Auth<wbr>State<wbr>InCookie<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:124</li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a name="default_framework_options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>FRAMEWORK_<wbr>OPTIONS</h3> <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>FRAMEWORK_<wbr>OPTIONS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:134</li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_framework_options.isangular-1" class="tsd-anchor"></a> <h3>is<wbr>Angular</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Angular<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:135</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_framework_options.protectedresourcemap-1" class="tsd-anchor"></a> <h3>protected<wbr>Resource<wbr>Map</h3> <div class="tsd-signature tsd-kind-icon">protected<wbr>Resource<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map<string, Array<string>>()</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:137</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_framework_options.unprotectedresources-1" class="tsd-anchor"></a> <h3>unprotected<wbr>Resources</h3> <div class="tsd-signature tsd-kind-icon">unprotected<wbr>Resources<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = new Array<string>()</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:136</li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a name="default_system_options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>SYSTEM_<wbr>OPTIONS</h3> <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SYSTEM_<wbr>OPTIONS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:127</li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_system_options.loadframetimeout-1" class="tsd-anchor"></a> <h3>load<wbr>Frame<wbr>Timeout</h3> <div class="tsd-signature tsd-kind-icon">load<wbr>Frame<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = FRAME_TIMEOUT</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:129</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_system_options.logger-1" class="tsd-anchor"></a> <h3>logger</h3> <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="../classes/_logger_.logger.html" class="tsd-signature-type">Logger</a><span class="tsd-signature-symbol"> = new Logger(null)</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:128</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_system_options.navigateframewait-1" class="tsd-anchor"></a> <h3>navigate<wbr>Frame<wbr>Wait</h3> <div class="tsd-signature tsd-kind-icon">navigate<wbr>Frame<wbr>Wait<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = NAVIGATE_FRAME_WAIT</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:131</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported"> <a name="default_system_options.tokenrenewaloffsetseconds-1" class="tsd-anchor"></a> <h3>token<wbr>Renewal<wbr>Offset<wbr>Seconds</h3> <div class="tsd-signature tsd-kind-icon">token<wbr>Renewal<wbr>Offset<wbr>Seconds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = OFFSET</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Configuration.ts:130</li> </ul> </aside> </section> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="_configuration_.html">"<wbr>Configuration"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#authoptions" class="tsd-kind-icon">Auth<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#cachelocation" class="tsd-kind-icon">Cache<wbr>Location</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#cacheoptions" class="tsd-kind-icon">Cache<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#configuration" class="tsd-kind-icon">Configuration</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#frameworkoptions" class="tsd-kind-icon">Framework<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#systemoptions" class="tsd-kind-icon">System<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_configuration_.html#telemetryoptions" class="tsd-kind-icon">Telemetry<wbr>Options</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#frame_timeout" class="tsd-kind-icon">FRAME_<wbr>TIMEOUT</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#navigate_frame_wait" class="tsd-kind-icon">NAVIGATE_<wbr>FRAME_<wbr>WAIT</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#offset" class="tsd-kind-icon">OFFSET</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_configuration_.html#buildconfiguration" class="tsd-kind-icon">build<wbr>Configuration</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#default_auth_options" class="tsd-kind-icon">DEFAULT_<wbr>AUTH_<wbr>OPTIONS</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#default_cache_options" class="tsd-kind-icon">DEFAULT_<wbr>CACHE_<wbr>OPTIONS</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#default_framework_options" class="tsd-kind-icon">DEFAULT_<wbr>FRAMEWORK_<wbr>OPTIONS</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_configuration_.html#default_system_options" class="tsd-kind-icon">DEFAULT_<wbr>SYSTEM_<wbr>OPTIONS</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><sp