15465 lines
226 KiB
HTML
15465 lines
226 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<title>ManagementClient - 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="module-auth.AuthenticationClient.html">AuthenticationClient</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#clientCredentialsGrant">clientCredentialsGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getClientInfo">getClientInfo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getDelegationToken">getDelegationToken</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getProfile">getProfile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestEmailCode">requestEmailCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestMagicLink">requestMagicLink</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestSMSCode">requestSMSCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#verifySMSCode">verifySMSCode</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html">DatabaseAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signUp">signUp</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html">OAuthAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#socialSignIn">s
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">ManagementClient</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<span class="ancestors"><a href="module-management.html">management</a>.</span>
|
||
|
|
|
||
|
|
ManagementClient
|
||
|
|
</h2>
|
||
|
|
|
||
|
|
<div class="class-description"><p>ManagementClient
|
||
|
|
Management API SDK.</p>
|
||
|
|
<p>The Auth0 Management API is meant to be used by back-end servers or trusted
|
||
|
|
parties performing administrative tasks. Generally speaking, anything that
|
||
|
|
can be done through the Auth0 dashboard (and more) can also be done through
|
||
|
|
this API.</p></div>
|
||
|
|
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Constructor</h2>
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="ManagementClient"><span class="type-signature"></span>new ManagementClient<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line87">line 87</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>options</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Options for the ManagementClient SDK.
|
||
|
|
If a token is provided only the domain is required, other parameters are ignored.
|
||
|
|
If no token is provided domain, clientId, clientSecret and scopes are required</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Attributes</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th>Default</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>domain</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>ManagementClient server domain.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>token</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>API access token.</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="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Management API Non Interactive Client Id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>clientSecret</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Management API Non Interactive Client Secret.</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="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Management API Audience. By default is your domain's, e.g. the domain is <code>tenant.auth0.com</code> and the audience is <code>http://tenant.auth0.com/api/v2/</code></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="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Management API Scopes.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>tokenProvider.enableCache</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Boolean</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
true
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Enabled or Disable Cache.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>tokenProvider.cacheTTLInSeconds</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>By default the <code>expires_in</code> value will be used to determine the cached time of the token, this can be overridden.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>retry.enabled</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Boolean</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
true
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Enabled or Disable Retry Policy functionality.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>retry.maxRetries</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
10
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Retry failed requests X times.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Examples</h5>
|
||
|
|
|
||
|
|
<p class="code-caption">
|
||
|
|
Initialize your client class with an API v2 token (you can generate one
|
||
|
|
<a href="https://auth0.com/docs/apiv2">here</a>) and a domain.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var ManagementClient = require('auth0').ManagementClient;
|
||
|
|
var auth0 = new ManagementClient({
|
||
|
|
domain: '{YOUR_ACCOUNT}.auth0.com',
|
||
|
|
token: '{YOUR_API_V2_TOKEN}'
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
<p class="code-caption">
|
||
|
|
Initialize your client class, by using a Non Interactive Client to fetch an access_token
|
||
|
|
via the Client Credentials Grant.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var ManagementClient = require('auth0').ManagementClient;
|
||
|
|
var auth0 = new ManagementClient({
|
||
|
|
domain: '{YOUR_ACCOUNT}.auth0.com',
|
||
|
|
clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}',
|
||
|
|
clientSecret: '{YOUR_NON_INTERACTIVE_CLIENT_SECRET}',
|
||
|
|
scope: "read:users write:users",
|
||
|
|
audience: 'https://{YOUR_TENANT_NAME}.auth0.com/api/v2/',
|
||
|
|
tokenProvider: {
|
||
|
|
enableCache: true,
|
||
|
|
cacheTTLInSeconds: 10
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Members</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="blacklistedTokens"><span class="type-signature"></span>blacklistedTokens<span class="type-signature"> :BlacklistedtokensManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
blacklisted tokens endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line183">line 183</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>BlacklistedtokensManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="clientGrants"><span class="type-signature"></span>clientGrants<span class="type-signature"> :ClientGrantsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the client grants
|
||
|
|
endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line143">line 143</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>ClientGrantsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="clients"><span class="type-signature"></span>clients<span class="type-signature"> :ClientsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
clients endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line135">line 135</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>ClientsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="connections"><span class="type-signature"></span>connections<span class="type-signature"> :ConnectionsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
connections endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line159">line 159</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>ConnectionsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="deviceCredentials"><span class="type-signature"></span>deviceCredentials<span class="type-signature"> :DeviceCredentialsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
device credentials endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line167">line 167</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>DeviceCredentialsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="emailProvider"><span class="type-signature"></span>emailProvider<span class="type-signature"> :EmailProviderManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
email provider endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line191">line 191</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>EmailProviderManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="jobs"><span class="type-signature"></span>jobs<span class="type-signature"> :JobsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Jobs manager.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line212">line 212</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>JobsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="logs"><span class="type-signature"></span>logs<span class="type-signature"> :LogsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Logs manager.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line226">line 226</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>LogsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="resourceServers"><span class="type-signature"></span>resourceServers<span class="type-signature"> :ResourceServersManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
resource servers endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line234">line 234</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>ResourceServersManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="rules"><span class="type-signature"></span>rules<span class="type-signature"> :RulesManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
rules endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line175">line 175</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>RulesManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="stats"><span class="type-signature"></span>stats<span class="type-signature"> :StatsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>ManagementClient account statistics manager.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line198">line 198</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>StatsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="tenant"><span class="type-signature"></span>tenant<span class="type-signature"> :TenantManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>ManagementClient tenant settings manager.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line205">line 205</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>TenantManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="tickets"><span class="type-signature"></span>tickets<span class="type-signature"> :TicketsManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Tickets manager.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line219">line 219</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>TicketsManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-members">
|
||
|
|
<h4 class="name" id="users"><span class="type-signature"></span>users<span class="type-signature"> :UsersManager</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Simple abstraction for performing CRUD operations on the
|
||
|
|
users endpoint.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line151">line 151</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Type:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<span class="param-type"><code>UsersManager</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Methods</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="blacklistToken"><span class="type-signature"></span>blacklistToken<span class="signature">(token, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Blacklist a new token.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1172">line 1172</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>token</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Token data.</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>aud</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Audience (your app client ID).</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>jti</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The JWT ID claim.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var token = {
|
||
|
|
aud: 'aud',
|
||
|
|
jti: 'jti'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.blacklistToken(token, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Token blacklisted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="configureEmailProvider"><span class="type-signature"></span>configureEmailProvider<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Configure the email provider.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1220">line 1220</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The email provider data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.configureEmailProvider(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Email provider configured.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createClient"><span class="type-signature"></span>createClient<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create an Auth0 client.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line431">line 431</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The client data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createClient(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Client created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createConnection"><span class="type-signature"></span>createConnection<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create a new connection.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line290">line 290</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createConnection(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Conection created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createDevicePublicKey"><span class="type-signature"></span>createDevicePublicKey<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create an Auth0 credential.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line603">line 603</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The device credential data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createConnection(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Credential created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createEmailVerificationTicket"><span class="type-signature"></span>createEmailVerificationTicket<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create an email verification ticket.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1495">line 1495</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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 class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var data = {
|
||
|
|
user_id: '{USER_ID}',
|
||
|
|
result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
|
||
|
|
};
|
||
|
|
|
||
|
|
auth0.createEmailVerificationTicket(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createPasswordChangeTicket"><span class="type-signature"></span>createPasswordChangeTicket<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create a new password change ticket.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1469">line 1469</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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 class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = {
|
||
|
|
result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
|
||
|
|
user_id: '{USER_ID}', // Optional.
|
||
|
|
email: '{USER_EMAIL}', // Optional.
|
||
|
|
new_password: '{PASSWORD}'
|
||
|
|
};
|
||
|
|
|
||
|
|
auth0.createPasswordChangeTicket(params, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createResourceServer"><span class="type-signature"></span>createResourceServer<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create a new resource server.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1560">line 1560</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createResourceServer(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Resource Server created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createRules"><span class="type-signature"></span>createRules<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create a new rule.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line688">line 688</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createRule(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Rule created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="createUser"><span class="type-signature"></span>createUser<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Create a new user.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line906">line 906</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>User data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.createUser(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// User created.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteAllUsers"><span class="type-signature"></span>deleteAllUsers<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete all users.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line860">line 860</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteAllUsers(function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Users deleted
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteClient"><span class="type-signature"></span>deleteClient<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete an Auth0 client.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line482">line 482</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Client 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>client_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Application client ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteClient({ client_id: CLIENT_ID }, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Client deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteConnection"><span class="type-signature"></span>deleteConnection<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete an existing connection.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line337">line 337</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteConnection({ id: CONNECTION_ID }, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Conection deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteDeviceCredential"><span class="type-signature"></span>deleteDeviceCredential<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete an Auth0 device credential.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line644">line 644</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Credential 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Device credential ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: CREDENTIAL_ID };
|
||
|
|
|
||
|
|
management.deleteDeviceCredential(params, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Credential deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteEmailProvider"><span class="type-signature"></span>deleteEmailProvider<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete email provider.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1243">line 1243</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteEmailProvider(function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Email provider deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteResourceServer"><span class="type-signature"></span>deleteResourceServer<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete an existing resource server.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1625">line 1625</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Resource Server deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteRule"><span class="type-signature"></span>deleteRule<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete an existing rule.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line735">line 735</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>auth0.deleteRule({ id: RULE_ID }, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Rule deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteUser"><span class="type-signature"></span>deleteUser<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete a user by its id.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line882">line 882</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user data object..</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.deleteUser({ id: USER_ID }, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// User deleted.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="deleteUserMultifactor"><span class="type-signature"></span>deleteUserMultifactor<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Delete a multifactor provider for a user.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1019">line 1019</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Data object.</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>provider</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Multifactor provider.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
|
||
|
|
|
||
|
|
management.deleteUserMultifcator(params, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Users accounts unlinked.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getActiveUsersCount"><span class="type-signature"></span>getActiveUsersCount<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get a the active users count.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1290">line 1290</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getActiveUsersCount(function (err, usersCount) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(usersCount);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getBlacklistedTokens"><span class="type-signature"></span>getBlacklistedTokens<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all blacklisted tokens.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1154">line 1154</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getBlacklistedTokens(function (err, tokens) {
|
||
|
|
console.log(tokens.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getClient"><span class="type-signature"></span>getClient<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get an Auth0 client.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line407">line 407</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Client 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>client_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Application client ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getClient({ client_id: CLIENT_ID }, function (err, client) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(client);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getClientInfo"><span class="type-signature"></span>getClientInfo<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Return an object with information about the current client,</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line239">line 239</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-returns">
|
||
|
|
<h5>Returns:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="param-type">
|
||
|
|
<dt>
|
||
|
|
Type:
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
<p>Object containing client information.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getClients"><span class="type-signature"></span>getClients<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all Auth0 clients.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line389">line 389</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getClients(function (err, clients) {
|
||
|
|
console.log(clients.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getConnection"><span class="type-signature"></span>getConnection<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get an Auth0 connection.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line313">line 313</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(connection);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getConnections"><span class="type-signature"></span>getConnections<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all connections.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line271">line 271</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getConnections(function (err, connections) {
|
||
|
|
console.log(connections.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getDailyStats"><span class="type-signature"></span>getDailyStats<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get the daily stats.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1312">line 1312</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Stats 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>from</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The first day in YYYYMMDD format.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>to</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The last day in YYYYMMDD format.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = {
|
||
|
|
from: '{YYYYMMDD}', // First day included in the stats.
|
||
|
|
to: '{YYYYMMDD}' // Last day included in the stats.
|
||
|
|
};
|
||
|
|
|
||
|
|
management.getDaily(params, function (err, stats) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(stats);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getDeviceCredentials"><span class="type-signature"></span>getDeviceCredentials<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all Auth0 credentials.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line626">line 626</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getDeviceCredentials(function (err, credentials) {
|
||
|
|
console.log(credentials.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getEmailProvider"><span class="type-signature"></span>getEmailProvider<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get the email provider.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1202">line 1202</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getEmailProvider(function (err, provider) {
|
||
|
|
console.log(provider.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getGuardianEnrollments"><span class="type-signature"></span>getGuardianEnrollments<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get a list of a user's Guardian enrollments.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1134">line 1134</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user data object.</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
|
||
|
|
console.log(enrollments);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getJob"><span class="type-signature"></span>getJob<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get a job by its ID.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1385">line 1385</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Job 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Job ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = {
|
||
|
|
id: '{JOB_ID}'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.getJob(params, function (err, job) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Retrieved job.
|
||
|
|
console.log(job);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getLog"><span class="type-signature"></span>getLog<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get an Auth0 log.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1518">line 1518</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Log 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Event ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getLog({ id: EVENT_ID }, function (err, log) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(log);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getLogs"><span class="type-signature"></span>getLogs<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all logs.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1541">line 1541</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Log data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getLogs(function (err, logs) {
|
||
|
|
console.log(logs.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getResourceServer"><span class="type-signature"></span>getResourceServer<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get a Resource Server.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1601">line 1601</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(resourceServer);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getResourceServers"><span class="type-signature"></span>getResourceServers<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all resource servers.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1582">line 1582</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection data object.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getResourceServers(function (err, resourceServers) {
|
||
|
|
console.log(resourceServers.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getRule"><span class="type-signature"></span>getRule<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get an Auth0 rule.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line711">line 711</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getRule({ id: RULE_ID }, function (err, rule) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(rule);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getRules"><span class="type-signature"></span>getRules<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all rules.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line670">line 670</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getRules(function (err, rules) {
|
||
|
|
console.log(rules.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getTenantSettings"><span class="type-signature"></span>getTenantSettings<span class="signature">(cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get the tenant settings..</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1342">line 1342</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getSettings(function (err, settings) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(settings);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getUser"><span class="type-signature"></span>getUser<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get a user by its id.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line840">line 840</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user data object.</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.getUser({ id: USER_ID }, function (err, user) {
|
||
|
|
console.log(user);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getUserLogs"><span class="type-signature"></span>getUserLogs<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get user's log events.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1105">line 1105</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Get logs data.</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>User id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>per_page</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Number of logs per page.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>page</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Page number.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>sort</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>include_totals</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Boolean</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>true if a query summary must be included in the result, false otherwise. Default false;</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
|
||
|
|
|
||
|
|
management.getUserLogs(params, function (err, logs) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(logs);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getUsers"><span class="type-signature"></span>getUsers<span class="signature">(params<span class="signature-attributes">opt</span>, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get all users.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line786">line 786</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</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>Users params.</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>per_page</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Number of users per page.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>page</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Number</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Page number.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<p class="code-caption">
|
||
|
|
This method takes an optional object as first argument that may be used to
|
||
|
|
specify pagination settings and the search query.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>// Pagination settings.
|
||
|
|
var params = {
|
||
|
|
per_page: 10,
|
||
|
|
page: 2
|
||
|
|
};
|
||
|
|
|
||
|
|
auth0.getUsers(params, function (err, users) {
|
||
|
|
console.log(users.length);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="getUsersByEmail"><span class="type-signature"></span>getUsersByEmail<span class="signature">(email<span class="signature-attributes">opt</span>, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Get users for a given email address</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line816">line 816</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Email Address of users to locate</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<p class="code-caption">
|
||
|
|
This method takes an email address as the first argument,
|
||
|
|
and returns all users with that email address
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>auth0.getUsersByEmail(email, function (err, users) {
|
||
|
|
console.log(users);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="importUsers"><span class="type-signature"></span>importUsers<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Given a path to a file and a connection id, create a new job that imports the
|
||
|
|
users contained in the file and associate them with the given connection.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1414">line 1414</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Users import data.</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>connectionId</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection for the users insertion.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>users</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Path to the users data file.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = {
|
||
|
|
connection_id: '{CONNECTION_ID}',
|
||
|
|
users: '{PATH_TO_USERS_FILE}'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.get(params, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="linkUsers"><span class="type-signature"></span>linkUsers<span class="signature">(userId, params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Link the user with another account.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1074">line 1074</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>userId</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>ID of the primary user.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Secondary user data.</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>user_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>ID of the user to be linked.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>connection_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>ID of the connection to be used.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID };
|
||
|
|
var data = {
|
||
|
|
user_id: 'OTHER_USER_ID',
|
||
|
|
connection_id: 'CONNECTION_ID'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.linkUsers(params, data, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Users linked.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="sendEmailVerification"><span class="type-signature"></span>sendEmailVerification<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Send a verification email to a user.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1443">line 1443</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>User data object.</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>user_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>ID of the user to be verified.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = {
|
||
|
|
user_id: '{USER_ID}'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.sendEmailVerification(function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="unlinkUsers"><span class="type-signature"></span>unlinkUsers<span class="signature">(params, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Unlink the given accounts.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1046">line 1046</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Linked users data.</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Primary user ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>provider</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Identity provider in use.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>user_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Secondary user ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
|
||
|
|
|
||
|
|
management.unlinkUsers(params, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Users accounts unlinked.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateAppMetadata"><span class="type-signature"></span>updateAppMetadata<span class="signature">(params, metadata, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update the app metadata for a user.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line988">line 988</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user data object..</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>metadata</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>New app metadata.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID };
|
||
|
|
var metadata = {
|
||
|
|
foo: 'bar'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.updateAppMetadata(params, metadata, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Updated user.
|
||
|
|
console.log(user);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateClient"><span class="type-signature"></span>updateClient<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update an Auth0 client.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line454">line 454</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Client 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>client_id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Application client ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Updated client data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var data = { name: 'newClientName' };
|
||
|
|
var params = { client_id: CLIENT_ID };
|
||
|
|
|
||
|
|
management.updateClient(params, data, function (err, client) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(client.name); // 'newClientName'
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateConnection"><span class="type-signature"></span>updateConnection<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update an existing connection.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_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>Attributes</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Conneciton 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Connection ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Updated connection data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var data = { name: 'newConnectionName' };
|
||
|
|
var params = { id: CONNECTION_ID };
|
||
|
|
|
||
|
|
management.updateConnection(params, data, function (err, connection) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(connection.name); // 'newConnectionName'
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateEmailProvider"><span class="type-signature"></span>updateEmailProvider<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update the email provider.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1265">line 1265</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Email provider parameters.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Updated email provider data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.updateEmailProvider(params, data, function (err, provider) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Updated email provider.
|
||
|
|
console.log(provider);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateResourceServer"><span class="type-signature"></span>updateResourceServer<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update an existing resource server.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1649">line 1649</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Resource Server ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Updated Resource Server data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var data = { name: 'newResourceServerName' };
|
||
|
|
var params = { id: RESOURCE_SERVER_ID };
|
||
|
|
|
||
|
|
management.updateResourceServer(params, data, function (err, resourceServer) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(resourceServer.name); // 'newResourceServerName'
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateRule"><span class="type-signature"></span>updateRule<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update an existing rule.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line759">line 759</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Rule ID.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Updated rule data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: RULE_ID };
|
||
|
|
var data = { name: 'my-rule'};
|
||
|
|
management.updateRule(params, data, function (err, rule) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log(rule.name); // 'my-rule'.
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateTenantSettings"><span class="type-signature"></span>updateTenantSettings<span class="signature">(data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update the tenant settings.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line1364">line 1364</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The new tenant settings.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function.</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>management.updateTenantSettings(data, function (err) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateUser"><span class="type-signature"></span>updateUser<span class="signature">(params, data, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update a user by its id.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line929">line 929</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user 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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>data</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>New user data.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID };
|
||
|
|
|
||
|
|
management.updateUser(params, data, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Updated user.
|
||
|
|
console.log(user);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-method">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4 class="name" id="updateUserMetadata"><span class="type-signature"></span>updateUserMetadata<span class="signature">(params, metadata, cb<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise|undefined}</span></h4>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<p>Update the user metadata for a user.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dt class="tag-source">Source:</dt>
|
||
|
|
<dd class="tag-source"><ul class="dummy"><li>
|
||
|
|
<a href="management_index.js.html">management/index.js</a>, <a href="management_index.js.html#line957">line 957</a>
|
||
|
|
</li></ul></dd>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Parameters:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<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>params</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user data object..</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>id</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>String</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>The user id.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>metadata</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>Object</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>New user metadata.</p>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>cb</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>function</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="attributes">
|
||
|
|
|
||
|
|
<optional><br>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
<p>Callback function</p>
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><code>undefined</code></span>
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="section-examples">
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre class="prettyprint"><code>var params = { id: USER_ID };
|
||
|
|
var metadata = {
|
||
|
|
address: '123th Node.js Street'
|
||
|
|
};
|
||
|
|
|
||
|
|
management.updateUserMetadata(params, metadata, function (err, user) {
|
||
|
|
if (err) {
|
||
|
|
// Handle error.
|
||
|
|
}
|
||
|
|
|
||
|
|
// Updated user.
|
||
|
|
console.log(user);
|
||
|
|
});</code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Dec 08 2017 10:01:22 GMT-0300 (-03) using the Minami theme.
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script>prettyPrint();</script>
|
||
|
|
<script src="scripts/linenumber.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|