adal-angular
Version:
Windows Azure Active Directory Client Library for js
500 lines (164 loc) • 9.64 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: config</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: config</h1>
<section>
<header>
<h2>
config
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="config"><span class="type-signature"></span>new config<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Configuration options for Authentication Context.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tenant</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Your target tenant.</td>
</tr>
<tr>
<td class="name"><code>clientId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Client ID assigned to your app by Azure Active Directory.</td>
</tr>
<tr>
<td class="name"><code>redirectUri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Endpoint at which you expect to receive tokens.Defaults to `window.location.href`.</td>
</tr>
<tr>
<td class="name"><code>instance</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Azure Active Directory Instance.Defaults to `https://login.microsoftonline.com/`.</td>
</tr>
<tr>
<td class="name"><code>endpoints</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Collection of {Endpoint-ResourceId} used for automatically attaching tokens in webApi calls.</td>
</tr>
<tr>
<td class="name"><code>popUp</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">Set this to true to enable login in a popup winodow instead of a full redirect.Defaults to `false`.</td>
</tr>
<tr>
<td class="name"><code>localLoginUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Set this to redirect the user to a custom login page.</td>
</tr>
<tr>
<td class="name"><code>displayCall</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">User defined function of handling the navigation to Azure AD authorization endpoint in case of login. Defaults to 'null'.</td>
</tr>
<tr>
<td class="name"><code>postLogoutRedirectUri</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Redirects the user to postLogoutRedirectUri after logout. Defaults is 'redirectUri'.</td>
</tr>
<tr>
<td class="name"><code>cacheLocation</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Sets browser storage to either 'localStorage' or sessionStorage'. Defaults to 'sessionStorage'.</td>
</tr>
<tr>
<td class="name"><code>anonymousEndpoints</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last">Array of keywords or URI's. Adal will not attach a token to outgoing requests that have these keywords or uri. Defaults to 'null'.</td>
</tr>
<tr>
<td class="name"><code>expireOffsetSeconds</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">If the cached token is about to be expired in the expireOffsetSeconds (in seconds), Adal will renew the token instead of using the cached token. Defaults to 300 seconds.</td>
</tr>
<tr>
<td class="name"><code>correlationId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unique identifier used to map the request with the response. Defaults to RFC4122 version 4 guid (128 bits).</td>
</tr>
<tr>
<td class="name"><code>loadFrameTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of milliseconds of inactivity before a token renewal response from AAD should be considered timed out.</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="adal.js.html">adal.js</a>, <a href="adal.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
</dd>
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="AuthenticationContext.html">AuthenticationContext</a></li><li><a href="config.html">config</a></li><li><a href="RequestInfo.html">RequestInfo</a></li><li><a href="User.html">User</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Oct 20 2017 15:19:15 GMT-0700 (PDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>