msal
Version:
Microsoft Authentication Library for js
366 lines • 21.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"utils/Constants" | 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="_utils_constants_.html">"utils/Constants"</a>
</li>
</ul>
<h1>External module "utils/Constants"</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>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_utils_constants_.errorcachekeys.html" class="tsd-kind-icon">Error<wbr>Cache<wbr>Keys</a></li>
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_utils_constants_.persistentcachekeys.html" class="tsd-kind-icon">Persistent<wbr>Cache<wbr>Keys</a></li>
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_utils_constants_.serverhashparamkeys.html" class="tsd-kind-icon">Server<wbr>Hash<wbr>Param<wbr>Keys</a></li>
</ul>
</section>
<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="_utils_constants_.html#interactiontype" class="tsd-kind-icon">Interaction<wbr>Type</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_utils_constants_.html#aad_instance_discovery_endpoint" class="tsd-kind-icon">AAD_<wbr>INSTANCE_<wbr>DISCOVERY_<wbr>ENDPOINT</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_utils_constants_.html#default_authority" class="tsd-kind-icon">DEFAULT_<wbr>AUTHORITY</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_utils_constants_.html#well_known_suffix" class="tsd-kind-icon">WELL_<wbr>KNOWN_<wbr>SUFFIX</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="_utils_constants_.html#libraryversion" class="tsd-kind-icon">library<wbr>Version</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_utils_constants_.html#frameprefix" class="tsd-kind-icon">Frame<wbr>Prefix</a></li>
<li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_utils_constants_.html#networkrequesttype" class="tsd-kind-icon">Network<wbr>Request<wbr>Type</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="interactiontype" class="tsd-anchor"></a>
<h3>Interaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Interaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"redirectInteraction"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"popupInteraction"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"silentInteraction"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L145">src/utils/Constants.ts:145</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
<a name="aad_instance_discovery_endpoint" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> AAD_<wbr>INSTANCE_<wbr>DISCOVERY_<wbr>ENDPOINT</h3>
<div class="tsd-signature tsd-kind-icon">AAD_<wbr>INSTANCE_<wbr>DISCOVERY_<wbr>ENDPOINT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = `${DEFAULT_AUTHORITY}/discovery/instance?api-version=1.1&authorization_endpoint=`</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L120">src/utils/Constants.ts:120</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
<a name="default_authority" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>AUTHORITY</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>AUTHORITY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://login.microsoftonline.com/common/"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L119">src/utils/Constants.ts:119</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
<a name="well_known_suffix" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> WELL_<wbr>KNOWN_<wbr>SUFFIX</h3>
<div class="tsd-signature tsd-kind-icon">WELL_<wbr>KNOWN_<wbr>SUFFIX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ".well-known/openid-configuration"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L121">src/utils/Constants.ts:121</a></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="libraryversion" class="tsd-anchor"></a>
<h3>library<wbr>Version</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">library<wbr>Version<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 <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L176">src/utils/Constants.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>MSAL JS Library Version</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
<a name="frameprefix" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Frame<wbr>Prefix</h3>
<div class="tsd-signature tsd-kind-icon">Frame<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L168">src/utils/Constants.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Frame name prefixes for the hidden iframe created in silent frames</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="frameprefix.id_token_frame" class="tsd-anchor"></a>
<h3>ID_<wbr>TOKEN_<wbr>FRAME</h3>
<div class="tsd-signature tsd-kind-icon">ID_<wbr>TOKEN_<wbr>FRAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "msalIdTokenFrame"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L169">src/utils/Constants.ts:169</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="frameprefix.token_frame" class="tsd-anchor"></a>
<h3>TOKEN_<wbr>FRAME</h3>
<div class="tsd-signature tsd-kind-icon">TOKEN_<wbr>FRAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "msalRenewFrame"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L170">src/utils/Constants.ts:170</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
<a name="networkrequesttype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Network<wbr>Request<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Network<wbr>Request<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L147">src/utils/Constants.ts:147</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="networkrequesttype.get" class="tsd-anchor"></a>
<h3>GET</h3>
<div class="tsd-signature tsd-kind-icon">GET<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "GET"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L148">src/utils/Constants.ts:148</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="networkrequesttype.post" class="tsd-anchor"></a>
<h3>POST</h3>
<div class="tsd-signature tsd-kind-icon">POST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "POST"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-core/src/utils/Constants.ts#L149">src/utils/Constants.ts:149</a></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="_utils_constants_.html">"utils/<wbr>Constants"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_utils_constants_.errorcachekeys.html" class="tsd-kind-icon">Error<wbr>Cache<wbr>Keys</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_utils_constants_.persistentcachekeys.html" class="tsd-kind-icon">Persistent<wbr>Cache<wbr>Keys</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_utils_constants_.serverhashparamkeys.html" class="tsd-kind-icon">Server<wbr>Hash<wbr>Param<wbr>Keys</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_utils_constants_.html#interactiontype" class="tsd-kind-icon">Interaction<wbr>Type</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="_utils_constants_.html#aad_instance_discovery_endpoint" class="tsd-kind-icon">AAD_<wbr>INSTANCE_<wbr>DISCOVERY_<wbr>ENDPOINT</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="_utils_constants_.html#default_authority" class="tsd-kind-icon">DEFAULT_<wbr>AUTHORITY</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="_utils_constants_.html#well_known_suffix" class="tsd-kind-icon">WELL_<wbr>KNOWN_<wbr>SUFFIX</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_utils_constants_.html#libraryversion" class="tsd-kind-icon">library<wbr>Version</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module">
<a href="_utils_constants_.html#frameprefix" class="tsd-kind-icon">Frame<wbr>Prefix</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module">
<a href="_utils_constants_.html#networkrequesttype" class="tsd-kind-icon">Network<wbr>Request<wbr>Type</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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>