react-native-auth0
Version:
React Native toolkit for Auth0 API
2,081 lines • 66.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<title>Auth - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"
/>
<link
type="text/css"
rel="stylesheet"
href="styles/prettify-tomorrow.css"
/>
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li>
<li class="nav-heading">Classes</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="Auth.html">Auth</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.authorizeUrl">authorizeUrl</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.createUser">createUser</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.exchange">exchange</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.exchangeNativeSocial"
>exchangeNativeSocial</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.loginWithEmail">loginWithEmail</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.loginWithSMS">loginWithSMS</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.logoutUrl">logoutUrl</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordlessWithEmail"
>passwordlessWithEmail</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordlessWithSMS"
>passwordlessWithSMS</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordRealm">passwordRealm</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.refreshToken">refreshToken</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.resetPassword">resetPassword</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.revoke">revoke</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.userInfo">userInfo</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="Auth0.html">Auth0</a></span>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"
><a href="Auth0.module.exports.html">module.exports</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="Users.html">Users</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Users.html#.getUser">getUser</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Users.html#.patchUser">patchUser</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="WebAuth.html">WebAuth</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="WebAuth.html#.authorize">authorize</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="WebAuth.html#.clearSession">clearSession</a></span
>
</li>
<li class="nav-heading"><a href="global.html">Globals</a></li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="global.html#users">users</a></span
>
</li>
</nav>
<div id="main">
<h1 class="page-title">Auth</h1>
<section>
<header>
<h2>
Auth
</h2>
</header>
<article>
<div class="container-overview">
<div class="section-method">
<h4 class="name" id="Auth">
<span class="type-signature"></span>new Auth<span
class="signature"
>()</span
><span class="type-signature"></span>
</h4>
<div class="description">
<p>Auth0 Auth API</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line14">line 14</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a href="https://auth0.com/docs/api/authentication"
>https://auth0.com/docs/api/authentication</a
>
</li>
</ul>
</dd>
</dl>
</div>
</div>
<h3 class="subsection-title">Methods</h3>
<div class="section-method">
<h4 class="name" id=".authorizeUrl">
<span class="type-signature">(static) </span>authorizeUrl<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {String}</span>
</h4>
<div class="description">
<p>
Builds the full authorize endpoint url in the Authorization
Server (AS) with given parameters.
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line44">line 44</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a
href="https://auth0.com/docs/api/authentication#authorize-client"
>https://auth0.com/docs/api/authentication#authorize-client</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>parameters to send to <code>/authorize</code></p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>responseType</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
type of the response to get from
<code>/authorize</code>.
</p>
</td>
</tr>
<tr>
<td class="name"><code>redirectUri</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
where the AS will redirect back after success or
failure.
</p>
</td>
</tr>
<tr>
<td class="name"><code>state</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>random string to prevent CSRF attacks.</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>String</code></span>
</dd>
</dl>
<div class="param-desc">
<p>
authorize url with specified parameters to redirect to for
AuthZ/AuthN.
</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".createUser">
<span class="type-signature">(static) </span>createUser<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line478">line 478</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>create user parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>email</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>user's email</p>
</td>
</tr>
<tr>
<td class="name"><code>username</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>user's username</p>
</td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>user's password</p>
</td>
</tr>
<tr>
<td class="name"><code>connection</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>
name of the database connection where to create
the user
</p>
</td>
</tr>
<tr>
<td class="name"><code>metadata</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
additional user information that will be stored in
<code>user_metadata</code>
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".exchange">
<span class="type-signature">(static) </span>exchange<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Exchanges a code obtained via <code>/authorize</code> (w/PKCE)
for the user's tokens
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line101">line 101</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a
href="https://auth0.com/docs/api-auth/grant/authorization-code-pkce"
>https://auth0.com/docs/api-auth/grant/authorization-code-pkce</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>parameters used to obtain tokens from a code</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>code returned by <code>/authorize</code>.</p>
</td>
</tr>
<tr>
<td class="name"><code>redirectUri</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
original redirectUri used when calling
<code>/authorize</code>.
</p>
</td>
</tr>
<tr>
<td class="name"><code>verifier</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
value used to generate the code challenge sent to
<code>/authorize</code>.
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".exchangeNativeSocial">
<span class="type-signature">(static) </span
>exchangeNativeSocial<span class="signature">(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Exchanges an external token obtained via a native social
authentication solution for the user's tokens
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line136">line 136</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a
href="https://auth0.com/docs/api/authentication#token-exchange-for-native-social"
>https://auth0.com/docs/api/authentication#token-exchange-for-native-social</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>
parameters used to obtain user tokens from an external
provider's token
</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>subjectToken</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>
token returned by the native social authentication
solution
</p>
</td>
</tr>
<tr>
<td class="name"><code>subjectTokenType</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>
identifier that indicates the native social
authentication solution
</p>
</td>
</tr>
<tr>
<td class="name"><code>userProfile</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
additional profile attributes to set or override,
only on select native social authentication
solutions
</p>
</td>
</tr>
<tr>
<td class="name"><code>audience</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>API audience to request</p>
</td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
scopes requested for the issued tokens. e.g.
<code>openid profile</code>
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".loginWithEmail">
<span class="type-signature">(static) </span>loginWithEmail<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Finishes the Passworldess authentication with an email
connection
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line296">line 296</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>passwordless parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>email</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the email where the link/code was received</p>
</td>
</tr>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the code numeric value (OTP)</p>
</td>
</tr>
<tr>
<td class="name"><code>audience</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>optional API audience to request</p>
</td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>optional scopes to request</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".loginWithSMS">
<span class="type-signature">(static) </span>loginWithSMS<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Finishes the Passworldess authentication with an SMS connection
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line330">line 330</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>passwordless parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>phoneNumber</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the phone number where the code was received</p>
</td>
</tr>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the code numeric value (OTP)</p>
</td>
</tr>
<tr>
<td class="name"><code>audience</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>optional API audience to request</p>
</td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>optional scopes to request</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".logoutUrl">
<span class="type-signature">(static) </span>logoutUrl<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {String}</span>
</h4>
<div class="description">
<p>
Builds the full logout endpoint url in the Authorization Server
(AS) with given parameters.
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line75">line 75</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a href="https://auth0.com/docs/api/authentication#logout"
>https://auth0.com/docs/api/authentication#logout</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>parameters to send to <code>/v2/logout</code></p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>federated</code></td>
<td class="type">
<span class="param-type"><code>Boolean</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
if the logout should include removing session for
federated IdP.
</p>
</td>
</tr>
<tr>
<td class="name"><code>clientId</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
client identifier of the one requesting the logout
</p>
</td>
</tr>
<tr>
<td class="name"><code>returnTo</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
url where the user is redirected to after logout.
It must be declared in you Auth0 Dashboard
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>String</code></span>
</dd>
</dl>
<div class="param-desc">
<p>logout url with specified parameters</p>
</div>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".passwordlessWithEmail">
<span class="type-signature">(static) </span
>passwordlessWithEmail<span class="signature">(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>Starts the Passworldess flow with an email connection</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line235">line 235</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>passwordless parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>email</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the email to send the link/code to</p>
</td>
</tr>
<tr>
<td class="name"><code>send</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
the passwordless strategy, either 'link' or 'code'
</p>
</td>
</tr>
<tr>
<td class="name"><code>authParams</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>
optional parameters, used when strategy is 'linḱ'
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".passwordlessWithSMS">
<span class="type-signature">(static) </span
>passwordlessWithSMS<span class="signature">(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>Starts the Passworldess flow with an SMS connection</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line264">line 264</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>passwordless parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>phoneNumber</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>the phone number to send the link/code to</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".passwordRealm">
<span class="type-signature">(static) </span>passwordRealm<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Performs Auth with user credentials using the Password Realm
Grant
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line172">line 172</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a
href="https://auth0.com/docs/api-auth/grant/password#realm-support"
>https://auth0.com/docs/api-auth/grant/password#realm-support</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>password realm parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>username</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>user's username or email</p>
</td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>user's password</p>
</td>
</tr>
<tr>
<td class="name"><code>realm</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>
name of the Realm where to Auth (or connection
name)
</p>
</td>
</tr>
<tr>
<td class="name"><code>audience</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
identifier of Resource Server (RS) to be included
as audience (aud claim) of the issued access token
</p>
</td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
scopes requested for the issued tokens. e.g.
<code>openid profile</code>
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".refreshToken">
<span class="type-signature">(static) </span>refreshToken<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Obtain new tokens using the Refresh Token obtained during Auth
(requesting <code>offline_access</code> scope)
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line205">line 205</a>
</li>
</ul>
</dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>
<a
href="https://auth0.com/docs/tokens/refresh-token/current#use-a-refresh-token"
>https://auth0.com/docs/tokens/refresh-token/current#use-a-refresh-token</a
>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>refresh token parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>refreshToken</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"></td>
<td class="description last">
<p>user's issued refresh token</p>
</td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="attributes"><optional><br /></td>
<td class="description last">
<p>
scopes requested for the issued tokens. e.g.
<code>openid profile</code>
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".resetPassword">
<span class="type-signature">(static) </span>resetPassword<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>
Request an email with instructions to change password of a user
</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line442">line 442</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>reset password parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>email</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>user's email</p>
</td>
</tr>
<tr>
<td class="name"><code>connection</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>name of the connection of the user</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".revoke">
<span class="type-signature">(static) </span>revoke<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>Revoke an issued refresh token</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line361">line 361</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>revoke token parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>refreshToken</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>user's issued refresh token</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
<div class="section-method">
<h4 class="name" id=".userInfo">
<span class="type-signature">(static) </span>userInfo<span
class="signature"
>(parameters)</span
><span class="type-signature"> → {Promise}</span>
</h4>
<div class="description">
<p>Return user information using an access token</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="src_auth_index.js.html">src/auth/index.js</a>,
<a href="src_auth_index.js.html#line392">line 392</a>
</li>
</ul>
</dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parameters</code></td>
<td class="type">
<span class="param-type"><code>Object</code></span>
</td>
<td class="description last">
<p>user info parameters</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>token</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>user's access token</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"><code>Promise</code></span>
</dd>
</dl>
</div>
</div>
</article>
</section>
</div>
<br class="clear" />
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
Minami theme.
</footer>
<script>
prettyPrint();
</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>