625 lines
48 KiB
HTML
625 lines
48 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<title>management/UsersManager.js - 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">management/UsersManager.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>var ArgumentError = require('rest-facade').ArgumentError;
|
||
|
|
var Auth0RestClient = require('../Auth0RestClient');
|
||
|
|
var RetryRestClient = require('../RetryRestClient');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Simple facade for consuming a REST API endpoint.
|
||
|
|
* @external RestClient
|
||
|
|
* @see https://github.com/ngonzalvez/rest-facade
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @class
|
||
|
|
* Abstracts interaction with the users endpoint.
|
||
|
|
* @constructor
|
||
|
|
* @memberOf module:management
|
||
|
|
*
|
||
|
|
* @param {Object} options The client options.
|
||
|
|
* @param {String} options.baseUrl The URL of the API.
|
||
|
|
* @param {Object} [options.headers] Headers to be included in all requests.
|
||
|
|
* @param {Object} [options.retry] Retry Policy Config
|
||
|
|
*/
|
||
|
|
var UsersManager = function (options){
|
||
|
|
if (options === null || typeof options !== 'object') {
|
||
|
|
throw new ArgumentError('Must provide manager options');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (options.baseUrl === null || options.baseUrl === undefined) {
|
||
|
|
throw new ArgumentError('Must provide a base URL for the API');
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
|
||
|
|
throw new ArgumentError('The provided base URL is invalid');
|
||
|
|
}
|
||
|
|
|
||
|
|
var clientOptions = {
|
||
|
|
errorFormatter: { message: 'message', name: 'error' },
|
||
|
|
headers: options.headers,
|
||
|
|
query: { repeatParams: false }
|
||
|
|
};
|
||
|
|
|
||
|
|
var usersAuth0RestClient = new Auth0RestClient(options.baseUrl + '/users/:id', clientOptions, options.tokenProvider);
|
||
|
|
this.users = new RetryRestClient(usersAuth0RestClient, options.retry);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides an abstraction layer for consuming the
|
||
|
|
* {@link https://auth0.com/docs/api/v2#!/Users/delete_multifactor_by_provider
|
||
|
|
* Multifactor Provider endpoint}.
|
||
|
|
*
|
||
|
|
* @type {external:RestClient}
|
||
|
|
*/
|
||
|
|
var multifactorAuth0RestClient = new Auth0RestClient(options.baseUrl + '/users/:id/multifactor/:provider', clientOptions, options.tokenProvider);
|
||
|
|
this.multifactor = new RetryRestClient(multifactorAuth0RestClient, options.retry);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides a simple abstraction layer for linking user accounts.
|
||
|
|
*
|
||
|
|
* @type {external:RestClient}
|
||
|
|
*/
|
||
|
|
var identitiesAuth0RestClient = new Auth0RestClient(options.baseUrl + '/users/:id/identities/:provider/:user_id', clientOptions, options.tokenProvider);
|
||
|
|
this.identities = new RetryRestClient(identitiesAuth0RestClient, options.retry);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides a simple abstraction layer for user logs
|
||
|
|
*
|
||
|
|
* @type {external:RestClient}
|
||
|
|
*/
|
||
|
|
var userLogsAuth0RestClient = new Auth0RestClient(options.baseUrl + '/users/:id/logs', clientOptions, options.tokenProvider);
|
||
|
|
this.userLogs = new RetryRestClient(userLogsAuth0RestClient, options.retry);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides an abstraction layer for retrieving Guardian enrollments.
|
||
|
|
*
|
||
|
|
* @type {external:RestClient}
|
||
|
|
*/
|
||
|
|
var enrollmentsAuth0RestClient = new Auth0RestClient(options.baseUrl + '/users/:id/enrollments', clientOptions, options.tokenProvider);
|
||
|
|
this.enrollments = new RetryRestClient(enrollmentsAuth0RestClient, options.retry);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides an abstraction layer for the new "users-by-email" API
|
||
|
|
*
|
||
|
|
* @type {external:RestClient}
|
||
|
|
*/
|
||
|
|
var usersByEmailClient = new Auth0RestClient(options.baseUrl + '/users-by-email', clientOptions, options.tokenProvider);
|
||
|
|
this.usersByEmail = new RetryRestClient(usersByEmailClient, options.retry);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a new user.
|
||
|
|
*
|
||
|
|
* @method create
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* management.users.create(data, function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // User created.
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} data User data.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.create = function (data, cb) {
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.users.create(data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.users.create(data);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all users.
|
||
|
|
*
|
||
|
|
* @method getAll
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* This method takes an optional object as first argument that may be used to
|
||
|
|
* specify pagination settings and the search query.
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* // Pagination settings.
|
||
|
|
* var params = {
|
||
|
|
* per_page: 10,
|
||
|
|
* page: 2
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* management.users.getAll(function (err, users) {
|
||
|
|
* console.log(users.length);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} [params] Users params.
|
||
|
|
* @param {Number} [params.per_page] Number of users per page.
|
||
|
|
* @param {Number} [params.page] Page number.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.getAll = function (params) {
|
||
|
|
return this.users.getAll.apply(this.users, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get Users by an Email Address
|
||
|
|
*
|
||
|
|
* @method getByEmail
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* This method takes a first argument as the Email address to look for
|
||
|
|
* users, and uses the /users-by-email API, not the search API
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* management.users.getByEmail('email@address', function (err, users) {
|
||
|
|
* console.log(users);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {String} [email] Email address of user(s) to find
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.getByEmail = function (email, callback) {
|
||
|
|
return this.usersByEmail.getAll({ email }, callback);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a user by its id.
|
||
|
|
*
|
||
|
|
* @method get
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* management.users.get({ id: USER_ID }, function (err, user) {
|
||
|
|
* console.log(user);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} data The user data object.
|
||
|
|
* @param {String} data.id The user id.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.get = function () {
|
||
|
|
return this.users.get.apply(this.users, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update a user by its id.
|
||
|
|
*
|
||
|
|
* @method update
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID };
|
||
|
|
*
|
||
|
|
* management.users.update(params, data, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Updated user.
|
||
|
|
* console.log(user);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params The user parameters.
|
||
|
|
* @param {String} params.id The user id.
|
||
|
|
* @param {Object} data New user data.
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.update = function () {
|
||
|
|
return this.users.patch.apply(this.users, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the user metadata.
|
||
|
|
*
|
||
|
|
* @method updateUserMetadata
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID };
|
||
|
|
* var metadata = {
|
||
|
|
* address: '123th Node.js Street'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* management.users.updateUserMetadata(params, metadata, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Updated user.
|
||
|
|
* console.log(user);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params The user data object..
|
||
|
|
* @param {String} params.id The user id.
|
||
|
|
* @param {Object} metadata New user metadata.
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.updateUserMetadata = function (params, metadata, cb) {
|
||
|
|
var data = {
|
||
|
|
user_metadata: metadata
|
||
|
|
};
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.users.patch(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.users.patch(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the app metadata.
|
||
|
|
*
|
||
|
|
* @method updateAppMetadata
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID };
|
||
|
|
* var metadata = {
|
||
|
|
* foo: 'bar'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* management.users.updateAppMetadata(params, metadata, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Updated user.
|
||
|
|
* console.log(user);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params The user data object..
|
||
|
|
* @param {String} params.id The user id.
|
||
|
|
* @param {Object} metadata New app metadata.
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.updateAppMetadata = function (params, metadata, cb) {
|
||
|
|
var data = {
|
||
|
|
app_metadata: metadata
|
||
|
|
};
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.users.patch(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.users.patch(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a user by its id.
|
||
|
|
*
|
||
|
|
* @method delete
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* management.users.delete({ id: USER_ID }, function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // User deleted.
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @param {Object} params The user data object..
|
||
|
|
* @param {String} params.id The user id.
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.delete = function (params) {
|
||
|
|
if (typeof params !== 'object' || typeof params.id !== 'string') {
|
||
|
|
throw new ArgumentError('You must provide an id for the delete method');
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.users.delete.apply(this.users, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete all users.
|
||
|
|
*
|
||
|
|
* @method deleteAll
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* management.users.deleteAll(function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Users deleted
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.deleteAll = function (cb) {
|
||
|
|
if (typeof cb !== 'function') {
|
||
|
|
var errorMsg = 'The deleteAll method only accepts a callback as argument';
|
||
|
|
|
||
|
|
throw new ArgumentError(errorMsg);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.users.delete.apply(this.users, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a multifactor provider.
|
||
|
|
*
|
||
|
|
* @method deleteMultifactorProvider
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
|
||
|
|
*
|
||
|
|
* management.users.deleteMultifactorProvider(params, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Users accounts unlinked.
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params Data object.
|
||
|
|
* @param {String} params.id The user id.
|
||
|
|
* @param {String} params.provider Multifactor provider.
|
||
|
|
* @param {Function} [cb] Callback function
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.deleteMultifactorProvider = function (params, cb) {
|
||
|
|
params = params || {};
|
||
|
|
|
||
|
|
if (!params.id || typeof params.id !== 'string') {
|
||
|
|
throw new ArgumentError('The id parameter must be a valid user id');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!params.provider || typeof params.provider !== 'string') {
|
||
|
|
throw new ArgumentError('Must specify a provider');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.multifactor.delete(params, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.multifactor.delete(params);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Link the user with another account.
|
||
|
|
*
|
||
|
|
* @method link
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID };
|
||
|
|
* var data = {
|
||
|
|
* user_id: 'OTHER_USER_ID',
|
||
|
|
* connection_id: 'CONNECTION_ID'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* management.users.link(params, data, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Users linked.
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {String} userId ID of the primary user.
|
||
|
|
* @param {Object} params Secondary user data.
|
||
|
|
* @param {String} params.user_id ID of the user to be linked.
|
||
|
|
* @param {String} params.connection_id ID of the connection to be used.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.link = function (userId, params, cb) {
|
||
|
|
var query = { id: userId };
|
||
|
|
params = params || {};
|
||
|
|
|
||
|
|
// Require a user ID.
|
||
|
|
if (!userId || typeof userId !== 'string') {
|
||
|
|
throw new ArgumentError('The userId cannot be null or undefined');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.identities.create(query, params, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.identities.create(query, params);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Unlink the given accounts.
|
||
|
|
*
|
||
|
|
* @method unlink
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
|
||
|
|
*
|
||
|
|
* management.users.unlink(params, function (err, user) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* // Users accounts unlinked.
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params Linked users data.
|
||
|
|
* @param {String} params.id Primary user ID.
|
||
|
|
* @param {String} params.provider Identity provider in use.
|
||
|
|
* @param {String} params.user_id Secondary user ID.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.unlink = function (params, cb) {
|
||
|
|
params = params || {};
|
||
|
|
|
||
|
|
if (!params.id || typeof params.id !== 'string') {
|
||
|
|
throw new ArgumentError('id field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!params.user_id || typeof params.user_id !== 'string') {
|
||
|
|
throw new ArgumentError('user_id field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!params.provider || typeof params.provider !== 'string') {
|
||
|
|
throw new ArgumentError('provider field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.identities.delete(params, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.identities.delete(params);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get user's log events.
|
||
|
|
*
|
||
|
|
* @method logs
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
|
||
|
|
*
|
||
|
|
* management.users.logs(params, function (err, logs) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* console.log(logs);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} params Get logs data.
|
||
|
|
* @param {String} params.id User id.
|
||
|
|
* @param {Number} params.per_page Number of logs per page.
|
||
|
|
* @param {Number} params.page Page number.
|
||
|
|
* @param {String} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
|
||
|
|
* @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.logs = function (params, cb) {
|
||
|
|
params = params || {};
|
||
|
|
|
||
|
|
if (!params.id || typeof params.id !== 'string') {
|
||
|
|
throw new ArgumentError('id field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.userLogs.get(params, cb);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a list of Guardian enrollments.
|
||
|
|
*
|
||
|
|
* @method getGuardianEnrollments
|
||
|
|
* @memberOf module:management.UsersManager.prototype
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
|
||
|
|
* console.log(enrollments);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} data The user data object.
|
||
|
|
* @param {String} data.id The user id.
|
||
|
|
* @param {Function} [cb] Callback function.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
UsersManager.prototype.getGuardianEnrollments = function () {
|
||
|
|
return this.enrollments.get.apply(this.enrollments, arguments);
|
||
|
|
};
|
||
|
|
|
||
|
|
module.exports = UsersManager;
|
||
|
|
</code></pre>
|
||
|
|
</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>
|