var Promise = require('bluebird');
-var retry = require('retry');
+ var retry = require('retry');
var ArgumentError = require('rest-facade').ArgumentError;
var assign = Object.assign || require('object.assign');
@@ -207,7 +206,7 @@ RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
index d8b4da672..e54f3f8f2 100644
--- a/docs/auth_DatabaseAuthenticator.js.html
+++ b/docs/auth_DatabaseAuthenticator.js.html
@@ -24,7 +24,7 @@
@@ -348,7 +348,7 @@ auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html
index c4719f3ae..bb9f2dd26 100644
--- a/docs/auth_OAUthWithIDTokenValidation.js.html
+++ b/docs/auth_OAUthWithIDTokenValidation.js.html
@@ -24,7 +24,7 @@
@@ -41,7 +41,6 @@ auth/OAUthWithIDTokenValidation.js
var jwt = require('jsonwebtoken');
var jwksClient = require('jwks-rsa');
-var Promise = require('bluebird');
var ArgumentError = require('rest-facade').ArgumentError;
var validateIdToken = require('./idToken').validate;
@@ -176,7 +175,7 @@ auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
index deddb3a18..fa83efadb 100644
--- a/docs/auth_OAuthAuthenticator.js.html
+++ b/docs/auth_OAuthAuthenticator.js.html
@@ -24,7 +24,7 @@
@@ -455,7 +455,7 @@ auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
index d73a8fd13..f1013c964 100644
--- a/docs/auth_PasswordlessAuthenticator.js.html
+++ b/docs/auth_PasswordlessAuthenticator.js.html
@@ -24,7 +24,7 @@
@@ -290,7 +290,7 @@ auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
index 290bfd9bd..534a339d2 100644
--- a/docs/auth_TokensManager.js.html
+++ b/docs/auth_TokensManager.js.html
@@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@ auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
index b0bc60166..47e3125e8 100644
--- a/docs/auth_UsersManager.js.html
+++ b/docs/auth_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@ auth/UsersManager.js
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html
index 58d4dd66f..69ab83442 100644
--- a/docs/auth_idToken.js.html
+++ b/docs/auth_idToken.js.html
@@ -24,7 +24,7 @@
@@ -202,7 +202,7 @@ auth/idToken.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
index 8f0454a49..38bb3ea9c 100644
--- a/docs/auth_index.js.html
+++ b/docs/auth_index.js.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ auth/index.js
diff --git a/docs/errors.js.html b/docs/errors.js.html
index 737f34acb..9230b6529 100644
--- a/docs/errors.js.html
+++ b/docs/errors.js.html
@@ -24,7 +24,7 @@
@@ -111,7 +111,7 @@ errors.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
index 2ba8f4c31..9a64f873f 100644
--- a/docs/external-RestClient.html
+++ b/docs/external-RestClient.html
@@ -24,7 +24,7 @@
@@ -87,7 +87,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/global.html b/docs/global.html
index 554e13252..94abd68ab 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@ Returns:
diff --git a/docs/index.html b/docs/index.html
index faba99df2..e61e0ab3c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index d4ab455e1..427337a68 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index f992f0d36..9c7f686d8 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index eb4e1406b..899157485 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 0d28e699b..b277bf52b 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 244f3c064..df64ebafc 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 0d43bce3b..35a175ce4 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 46a063043..5021c9fd7 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 2ad6f346b..231ddf001 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 5cb1f503a..e2edac4a3 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 55fc81c55..001535dd4 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index 5178c65b5..0dbda649b 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 94f8fc428..935db940f 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -508,7 +508,7 @@ management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html
index dc6721870..84cda3d75 100644
--- a/docs/management_HooksManager.js.html
+++ b/docs/management_HooksManager.js.html
@@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@ management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 662d40b99..2292504a9 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -41,7 +41,6 @@ management/JobsManager.js
var axios = require('axios');
var extend = require('util')._extend;
-var Promise = require('bluebird');
var FormData = require('form-data');
var fs = require('fs');
@@ -433,7 +432,7 @@ management/JobsManager.js
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html
new file mode 100644
index 000000000..046223337
--- /dev/null
+++ b/docs/management_LogStreamsManager.js.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+ management/LogStreamsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/LogStreamsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class LogStreamsManager
+ * The logStreams class provides a simple abstraction for performing CRUD operations
+ * on Auth0 Log Streams.
+ * @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 LogStreamsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide client 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');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for performing CRUD operations on
+ * {@link https://auth0.com/docs/api/management/v2#!/Log_Streams Auth0
+ * Log Streams}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/log-streams/:id ',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+/**
+ * Get all Log Streams.
+ *
+ * @method getAll
+ * @memberOf module:management.LogStreamsManager.prototype
+ *
+ * @example
+ *
+ * management.logStreams.getAll(function (err, logStreams) {
+ * console.log(logStreams.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(LogStreamsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get an Auth0 Log Streams.
+ *
+ * @method get
+ * @memberOf module:management.LogStreamsManager.prototype
+ *
+ * @example
+ * management.logStreams.get({ id: LOG_STREAM_ID }, function (err, logStream) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(logStream);
+ * });
+ *
+ * @param {Object} params Log Stream parameters.
+ * @param {String} params.id Log Stream ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(LogStreamsManager, 'get', 'resource.get');
+
+/**
+ * Create an Auth0 Log Stream.
+ *
+ * @method create
+ * @memberOf module:management.LogStreamsManager.prototype
+ *
+ * @example
+ * management.logStreams.create(data, function (err, log) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(log);
+ * });
+ *
+ * @param {Object} data Log Stream data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(LogStreamsManager, 'create', 'resource.create');
+
+/**
+ * Update an Auth0 Log Streams.
+ *
+ * @method update
+ * @memberOf module:management.LogStreamsManager.prototype
+ *
+ * @example
+ * var data = { name: 'New name' };
+ * var params = { id: LOG_STREAM_ID };
+ *
+ * // Using auth0 instance.
+ * management.updateLogStream(params, data, function (err, logStream) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(logStream.name); // 'New name'
+ * });
+ *
+ * // Using the logStreams manager directly.
+ * management.logStreams.update(params, data, function (err, logStream) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(logStream.name);
+ * });
+ *
+ * @param {Object} params Log Stream parameters.
+ * @param {String} params.id Log Stream ID.
+ * @param {Object} data Updated Log Stream data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(LogStreamsManager, 'update', 'resource.patch');
+
+/**
+ * Delete an Auth0 Log Streams.
+ *
+ * @method delete
+ * @memberOf module:management.LogStreamsManager.prototype
+ *
+ * @example
+ * management.logStreams.delete({ id: LOG_STREAM_ID }, function (err, log) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(log);
+ * });
+ *
+ * @param {Object} params Log Stream parameters.
+ * @param {String} params.id Log Stream ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(LogStreamsManager, 'delete', 'resource.delete');
+
+module.exports = LogStreamsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index a7fb1d130..893fe0103 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index 7d71d1acc..5a7d686ae 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -43,7 +43,7 @@ management/ManagementTokenProvider.js
var assign = Object.assign || require('object.assign');
var AuthenticationClient = require('../auth');
var memoizer = require('lru-memoizer');
-var Promise = require('bluebird');
+var es6Promisify = require('es6-promisify');
var DEFAULT_OPTIONS = { enableCache: true };
@@ -114,7 +114,7 @@ management/ManagementTokenProvider.js
this.authenticationClient = new AuthenticationClient(authenticationClientOptions);
var self = this;
- this.getCachedAccessToken = Promise.promisify(
+ this.getCachedAccessToken = es6Promisify.promisify(
memoizer({
load: function(options, callback) {
self
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html
index 900433ae6..1951ee4d6 100644
--- a/docs/management_MigrationsManager.js.html
+++ b/docs/management_MigrationsManager.js.html
@@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@ management/MigrationsManager.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index bfab18e5c..dc5dc3651 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index e694f56c7..9b47588b9 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 081b11804..6053de699 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index cb2bc28c8..ac46b4f37 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 45871c5a0..585c25a01 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index 3fc27a75e..b64d30df6 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 87a767da4..802f708f4 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 0a9be204e..5aa8a95fa 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index 1b97864ab..72f81eaa1 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 27f7e8e96..07b5e1ff8 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a1bef4216..361b51915 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -64,6 +64,7 @@ management/index.js
var JobsManager = require('./JobsManager');
var TicketsManager = require('./TicketsManager');
var LogsManager = require('./LogsManager');
+var LogStreamsManager = require('./LogStreamsManager');
var ResourceServersManager = require('./ResourceServersManager');
var ManagementTokenProvider = require('./ManagementTokenProvider');
var RulesConfigsManager = require('./RulesConfigsManager');
@@ -323,6 +324,13 @@ management/index.js
*/
this.logs = new LogsManager(managerOptions);
+ /**
+ * Log Streams manager.
+ *
+ * @type {LogStreamsManager}
+ */
+ this.logStreams = new LogStreamsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* resource servers endpoint.
@@ -2287,6 +2295,118 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'getLogs', 'logs.getAll');
+/**
+ * Get all Log Streams.
+ *
+ * @method getLogStreams
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ *
+ *
+ * management.getLogStreams( function (err, logStreams) {
+ * console.log(logStreams.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getLogStreams', 'logStreams.getAll');
+
+/**
+ * Create a new Log Stream.
+ *
+ * @method createLogStream
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createLogStream(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Log Stream created.
+ * });
+ *
+ * @param {Object} data Log Stream data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createLogStream', 'logStreams.create');
+
+/**
+ * Get an Auth0 Log Stream.
+ *
+ * @method getLogStream
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(logStream);
+ * });
+ *
+ * @param {Object} params Log Stream parameters.
+ * @param {String} params.id Log Stream ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getLogStream', 'logStreams.get');
+
+/**
+ * Delete an existing Log Stream.
+ *
+ * @method deleteLogStream
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.deleteLogStream({ id: LOG_STREAM_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Log Stream deleted.
+ * });
+ *
+ * @param {Object} params Log Stream parameters.
+ * @param {String} params.id Log Stream ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteLogStream', 'logStreams.delete');
+
+/**
+ * Update an existing Log Stream.
+ *
+ * @method updateLogStream
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = { id: LOG_STREAM_ID };
+ * var data = { name: 'my-log-stream'};
+ * management.updateLogStream(params, data, function (err, logStream) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(logStream.name); // 'my-log-stream'.
+ * });
+ *
+ * @param {Object} params Rule parameters.
+ * @param {String} params.id Rule ID.
+ * @param {Object} data Updated rule data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateLogStream', 'logStreams.update');
+
/**
* Create a new resource server.
*
@@ -3455,7 +3575,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index e95341fa0..64d5b7fa5 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 9efc24c06..8143b5325 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 37827f5b8..688a902c4 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index e0aa24d29..9fce40de1 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 751bf4a5a..1e01aeadf 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 4b018152a..8107505e6 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1931529ce..963840526 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index e620f8d40..5d4adc26e 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index b5fb34b2c..5181655f9 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 5181f64dc..55ed93c29 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index 2d6f89c76..da0e59028 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index b1a4b50a9..24d1070a2 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 924e1aa52..da407505d 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 4c7f272b5..790b64ab7 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -2269,7 +2269,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 485165003..4f9052b10 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e5354c894..8d7d8faee 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1215,7 +1215,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 1fcea65f4..65f17ebde 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index b0f5bc42e..e5f26542a 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 78eda1d1e..94b1f24ec 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ca46756b1..ce435b2ed 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -4415,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 7813721ce..60b7bcd7f 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index c4c4508ef..361c508e3 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new JobsMa
Source:
(inner) Source:
(inner)
Source:
(inne
Source:
errorsSource:
exportUser
Source:
getSource:
importUser
Source:
importU
Source:
verifyEmai
Source:
Example
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html
new file mode 100644
index 000000000..164cfc436
--- /dev/null
+++ b/docs/module-management.LogStreamsManager.html
@@ -0,0 +1,1772 @@
+
+
+
+
+
+ LogStreamsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LogStreamsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ LogStreamsManager
+
+
+ LogStreamsManager
+The logStreams class provides a simple abstraction for performing CRUD operations
+on Auth0 Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new LogStreamsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for performing CRUD operations on
+Auth0 Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ create(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create an Auth0 Log Stream.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.logStreams.create(data, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.logStreams.delete({ id: LOG_STREAM_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ get(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.logStreams.get({ id: LOG_STREAM_ID }, function (err, logStream) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logStream);
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.logStreams.getAll(function (err, logStreams) {
+ console.log(logStreams.length);
+});
+
+
+
+
+
+
+
+
+
+
+ update(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an Auth0 Log Streams.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Log Stream data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { name: 'New name' };
+var params = { id: LOG_STREAM_ID };
+
+// Using auth0 instance.
+management.updateLogStream(params, data, function (err, logStream) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logStream.name); // 'New name'
+});
+
+// Using the logStreams manager directly.
+management.logStreams.update(params, data, function (err, logStream) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logStream.name);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a656ea1e4..9cefd38ce 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index e340b32dd..f87089d8b 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+logStreams :LogStreamsManager
+
+
+
+
+
+ Log Streams manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
LogStreamsManager
+
+
+
+
+
+
+
+
+
@@ -1810,7 +1884,7 @@ migrations<
Source:
resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createLogStream(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create a new Log Stream.
@@ -6369,7 +6443,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream data.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -6490,23 +6601,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}'
-};
-
-// or
-
-var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- email: '{USER_EMAIL}',
- connection_id: '{CONNECTION}' // eg. con_00000000001
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createLogStream(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Log Stream created.
});
@@ -6518,14 +6618,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create a new password change ticket.
@@ -6561,7 +6661,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -6719,12 +6782,23 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}'
+};
+
+// or
+
+var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ email: '{USER_EMAIL}',
+ connection_id: '{CONNECTION}' // eg. con_00000000001
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -6736,14 +6810,14 @@ Example
- createRole(data, cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Create a new role.
+ Create a new resource server.
@@ -6779,7 +6853,7 @@ createRole<
Source:
Parameters:
- Role data object.
+ Resource Server data object.
@@ -6937,13 +7011,12 @@ Returns:
Example
- data = {"name": "test1","description": "123"}
-management.createRole(data, function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Role created.
+ // Resource Server created.
});
@@ -6955,14 +7028,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createRole(data, cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a new role.
@@ -6998,7 +7071,7 @@ createRule<
Source:
Parameters:
- Rule data object.
+ Role data object.
@@ -7156,12 +7229,13 @@ Returns:
Example
- management.createRule(data, function (err) {
+ data = {"name": "test1","description": "123"}
+management.createRole(data, function (err) {
if (err) {
// Handle error.
}
- // Rule created.
+ // Role created.
});
@@ -7173,14 +7247,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Create a new user.
+ Create a new rule.
@@ -7216,7 +7290,7 @@ createUser<
Source:
Parameters:
- User data.
+ Rule data object.
@@ -7374,12 +7448,12 @@ Returns:
Example
- management.createUser(data, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // User created.
+ // Rule created.
});
@@ -7391,14 +7465,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new user.
@@ -7422,8 +7496,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ User data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createUser(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User created.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteAllUsers(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Deprecated:
- This method will be removed in the next major release.
- Source:
+ deleteCli
- Source:
dele
- Source:
delet
- Source:
del
- Source:
Source:
de
- Source:
Source:
deleteHook<
- Source:
Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteLogStream(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing Log Stream.
@@ -9689,7 +9981,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Log Stream parameters.
@@ -9803,7 +10095,7 @@ Parameters:
- Resource Server ID.
+ Log Stream ID.
@@ -9898,12 +10190,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteLogStream({ id: LOG_STREAM_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Log Stream deleted.
});
@@ -9915,14 +10207,14 @@ Example
- deleteRole(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete an existing role.
+ Delete an existing resource server.
@@ -9958,7 +10250,7 @@ deleteRole<
- Source:
Parameters:
- Role parameters.
+ Resource Server parameters.
@@ -10072,7 +10364,7 @@ Parameters:
- Role ID.
+ Resource Server ID.
@@ -10167,12 +10459,12 @@ Returns:
Example
- management.deleteRole({ id: ROLE_ID }, function (err) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Role deleted.
+ // Resource Server deleted.
});
@@ -10184,14 +10476,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteRole(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete an existing role.
@@ -10227,7 +10519,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Role parameters.
@@ -10341,7 +10633,7 @@ Parameters:
- Rule ID.
+ Role ID.
@@ -10436,12 +10728,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteRole({ id: ROLE_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // Role deleted.
});
@@ -10453,14 +10745,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an existing rule.
@@ -10496,7 +10788,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Rule parameters.
@@ -10593,7 +10885,7 @@ Parameters:
- keyid
@@ -10610,7 +10902,7 @@ Parameters:
- Rule Configs key.
+ Rule ID.
@@ -10705,12 +10997,12 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Rule deleted.
});
@@ -10722,14 +11014,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete rules config.
@@ -10765,7 +11057,7 @@ deleteUser<
- Source:
Parameters:
- The user data object..
+ Rule Configs parameters.
@@ -10862,7 +11154,7 @@ Parameters:
- idkey
@@ -10879,7 +11171,7 @@ Parameters:
- The user id.
+ Rule Configs key.
@@ -10923,7 +11215,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -10974,12 +11266,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Rules Config deleted.
});
@@ -10991,14 +11283,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user by its id.
@@ -11034,7 +11326,7 @@
- Source:
Parameters:
- Data object.
+ The user data object..
@@ -11154,32 +11446,6 @@ Parameters:
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
-
-
-
-
-
@@ -11269,14 +11535,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // User deleted.
});
@@ -11288,7 +11552,7 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
@@ -11319,10 +11583,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Example
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-management.deleteUserMultifcator(params, function (err, user) {
+management.deleteUserMultifactor(params, function (err, user) {
if (err) {
// Handle error.
}
@@ -11589,14 +11849,14 @@ Example
- exportUsers(data, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Export all users to a file using a long running job.
+ Delete a multifactor provider for a user.
@@ -11620,6 +11880,10 @@ exportUser
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
exportUser
Source:
Parameters:
- dataparams
@@ -11703,7 +11967,7 @@ Parameters:
- Users export data.
+ Data object.
@@ -11717,8 +11981,6 @@ Parameters:
Type
- Attributes
-
@@ -11731,7 +11993,7 @@ Parameters:
- connection_idid
@@ -11744,21 +12006,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- The connection id of the connection from which users will be exported
+ The user id.
@@ -11767,7 +12019,7 @@ Parameters:
- formatprovider
@@ -11780,93 +12032,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- The format of the file. Valid values are: "json" and "csv".
-
-
-
-
-
-
-
-
- limit
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Limit the number of records.
-
-
-
-
-
-
-
-
- fields
-
-
-Array.<Object>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ Multifactor provider.
@@ -11910,7 +12080,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -11961,37 +12131,14 @@ Returns:
Example
- var data = {
- connection_id: 'con_0000000000000001',
- format: 'csv',
- limit: 5,
- fields: [
- {
- "name": "user_id"
- },
- {
- "name": "name"
- },
- {
- "name": "email"
- },
- {
- "name": "identities[0].connection",
- "export_as": "provider"
- },
- {
- "name": "user_metadata.some_field"
- }
- ]
-}
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-management.exportUsers(data, function (err, results) {
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(results);
+ // Users accounts unlinked.
});
@@ -12003,122 +12150,14 @@ Example
- getAccessToken() → {Promise}
-
-
-
-
-
-
- Returns the access_token.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-
-
-
-
-
-
-
- Promise returning an access_token.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Export all users to a file using a long running job.
@@ -12154,7 +12193,529 @@ ge
Source:
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
+
+
+
+
+ getAccessToken() → {Promise}
+
+
+
+
+
+
+ Returns the access_token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+
+
+
+
+
+
+
+ Promise returning an access_token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getActiveUsersCount(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a the active users count.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ g
- Source:
ge
- Source:
getClientSource:
getCli
- Source:
getClients<
- Source:
getConne
- Source:
getConn
- Source:
getCus
- Source:
getCu
- Source:
getDaily
- Source:
g
- Source:
getEm
- Source:
getEm
- Source:
getGrantsSource:
- Source:
Source:
Source:
get
- Source:
Source:
Source:
Source:
ge
- Source:
getHookSource:
getHooksSource:
getHook
- Source:
getJobSource:
getLogSource:
getLogsSource:
Example
+
+
+
+
+ getLogStream(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 Log Stream.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logStream);
+});
+
+
+
+
+
+
@@ -19773,7 +20603,7 @@ getMigra
Source:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserB
Source:
Source:
getUserLog
Source:
get
Source:
getUserRo
Source:
getUsersSource:
getUse
Source:
getUser
Source:
importUser
Source:
Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
+
+management.importUsers(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Link the user with another account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
};
-management.importUsers(params, function (err) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users linked.
});
@@ -25571,14 +26736,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Generate new Guardian recovery code.
@@ -25614,7 +26779,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -25719,7 +26850,7 @@ Parameters:
- Secondary user data.
+ The user data object.
@@ -25745,33 +26876,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idid
@@ -25788,7 +26893,7 @@ Parameters:
- ID of the connection to be used.
+ The user id.
@@ -25883,18 +26988,8 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
-
-management.linkUsers(userId, params, function (err, user) {
- if (err) {
- // Handle error.
- }
-
- // Users linked.
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -25906,14 +27001,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Delete an existing hook.
@@ -25949,7 +27044,7 @@ Source:
Parameters:
- dataparams
@@ -26020,7 +27115,7 @@ Parameters:
- The user data object.
+ Hook parameters.
@@ -26063,7 +27158,7 @@ Parameters:
- The user id.
+ Hook ID.
@@ -26078,6 +27173,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secrets key/value pairs
+
+
+
+
+
+
cbReturns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -26171,14 +27306,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Remove permissions from a role
@@ -26214,7 +27349,7 @@ remo
Source:
Parameters:
- paramsparams.id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the Role.
+
+
+
+
+
+
+
+
+ data
@@ -26285,7 +27454,7 @@ Parameters:
- Hook parameters.
+ permissions data
@@ -26311,7 +27480,7 @@ Parameters:
- idpermissions
@@ -26328,15 +27497,50 @@ Parameters:
- Hook ID.
+ Array of permissions
-
-
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
-
-
+
+
+ permission_name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of a permission
@@ -26345,32 +27549,40 @@ Parameters:
- dataresource_server_identifier
-Object
+String
-
-
+
+
+
+ Identifier for a resource
+
+
+
+
+
+
-
-
+
+
-
+
+
+
-
- Secrets key/value pairs
@@ -26457,14 +27669,11 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
- if (err) {
- // Handle error.
- }
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
- // Hook deleted.
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -26476,14 +27685,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Remove permissions from a user
@@ -26519,7 +27728,7 @@ Source:
Parameters:
- params.id
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the Role.
-
-
-
-
-
-
-
-
- dataparams
@@ -26624,7 +27799,7 @@ Parameters:
- permissions data
+ params object
@@ -26650,7 +27825,7 @@ Parameters:
- permissionsid
@@ -26667,33 +27842,24 @@ Parameters:
- Array of permissions
+ user_id
-
-
-
-
-
-
- Name
-
-
- Type
-
-
+
+
-
+
+
+
- Description
-
-
+
+
+
-
- permission_namedata
@@ -26706,20 +27872,45 @@ Parameters:
+
+
+
+
+
+
+
+
- Name of a permission
+ data object containing list of permission IDs
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- resource_server_identifierpermissions
@@ -26736,15 +27927,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ Array of permission IDs
@@ -26839,11 +28022,15 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
+ var parms = { id : 'USER_ID'};
var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+management.removePermissionsFromUser(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User assigned permissions.
});
@@ -26855,14 +28042,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Remove roles from a user
@@ -26898,7 +28085,7 @@ Source:
Parameters:
- data object containing list of permission IDs
+ data object containing list of role IDs
@@ -27080,7 +28267,7 @@ Parameters:
- permissionsroles
@@ -27097,7 +28284,7 @@ Parameters:
- Array of permission IDs
+ Array of role IDs
@@ -27193,14 +28380,14 @@ Returns:
Example
var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+var data = { "roles" :["role1"]};
-management.removePermissionsFromUser(params, data, function (err) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // User assigned roles.
});
@@ -27212,14 +28399,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Send a verification email to a user.
@@ -27255,7 +28442,7 @@ re
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- params object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- user_id
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
-String
+Object
@@ -27411,7 +28513,7 @@ Parameters:
- data object containing list of role IDs
+ User data object.
@@ -27437,7 +28539,7 @@ Parameters:
- rolesuser_id
@@ -27454,7 +28556,7 @@ Parameters:
- Array of role IDs
+ ID of the user to be verified.
@@ -27549,15 +28651,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = {
+ user_id: '{USER_ID}'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.sendEmailVerification(params, function (err) {
if (err) {
// Handle error.
}
-
- // User assigned roles.
});
@@ -27569,14 +28670,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Set a new rules config.
@@ -27612,7 +28713,7 @@
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- User data object.
+ Rule Config Data parameters.
@@ -27709,7 +28895,7 @@ Parameters:
- user_idvalue
@@ -27726,7 +28912,7 @@ Parameters:
- ID of the user to be verified.
+ Rule Config Data value.
@@ -27821,14 +29007,15 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
-management.sendEmailVerification(params, function (err) {
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
+
+ // Rules Config set.
});
@@ -27840,14 +29027,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Unblock an user by its id.
@@ -27883,7 +29070,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ The user data object..
@@ -28065,7 +29167,7 @@ Parameters:
- valueid
@@ -28082,7 +29184,7 @@ Parameters:
- Rule Config Data value.
+ The user id.
@@ -28126,7 +29228,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -28177,15 +29279,12 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
-
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // User unblocked.
});
@@ -28240,7 +29339,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -28354,7 +29453,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -28449,7 +29548,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -28466,14 +29565,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Unlink the given accounts.
@@ -28509,7 +29608,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Linked users data.
@@ -28606,7 +29705,7 @@ Parameters:
- identifierid
@@ -28623,7 +29722,59 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Secondary user ID.
@@ -28667,7 +29818,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -28718,12 +29869,14 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User unblocked.
+ // Users accounts unlinked.
});
@@ -28735,14 +29888,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the app metadata for a user.
@@ -28778,7 +29931,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ The user data object..
@@ -28892,7 +30045,15 @@ Parameters:
- Primary user ID.
+ The user id.
+
+
+
+
+
+
+
+
@@ -28901,24 +30062,32 @@ Parameters:
- providermetadata
-String
+Object
+
+
+
+
+
+
+
+
- Identity provider in use.
+ New app metadata.
@@ -28927,24 +30096,34 @@ Parameters:
- user_idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Secondary user ID.
+ Callback function
@@ -28953,6 +30132,220 @@ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the branding settings.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branding parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated branding data.
@@ -29039,14 +30432,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+// Updated branding
+ console.log(branding);
});
@@ -29058,14 +30450,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client.
@@ -29101,7 +30493,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -29198,7 +30590,7 @@ Parameters:
- idclient_id
@@ -29215,7 +30607,7 @@ Parameters:
- The user id.
+ Application client ID.
@@ -29232,7 +30624,7 @@ Parameters:
- metadatadata
@@ -29257,7 +30649,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -29293,7 +30685,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -29344,18 +30736,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(client.name); // 'newClientName'
});
@@ -29367,14 +30756,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update an Auth0 client grant.
@@ -29410,7 +30799,7 @@ Source:
Parameters:
- Branding parameters.
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client grant ID.
+
+
+
+
+
+
+
+
@@ -29515,7 +30955,7 @@ Parameters:
- Updated branding data.
+ Updated client data.
@@ -29602,13 +31042,19 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
-// Updated branding
- console.log(branding);
+ console.log(grant.id);
});
@@ -29620,14 +31066,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -29663,7 +31109,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -29760,7 +31206,7 @@ Parameters:
- client_idid
@@ -29777,7 +31223,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -29819,7 +31265,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -29906,15 +31352,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -29926,14 +31372,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the email provider.
@@ -29969,7 +31415,7 @@ upda
Source:
Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -30125,7 +31520,7 @@ Parameters:
- Updated client data.
+ Updated email provider data.
@@ -30212,19 +31607,13 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(grant.id);
+ // Updated email provider.
+ console.log(provider);
});
@@ -30236,14 +31625,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update an existing Email Template.
@@ -30279,7 +31668,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Email Template parameters.
@@ -30376,7 +31765,7 @@ Parameters:
- idname
@@ -30393,7 +31782,7 @@ Parameters:
- Connection ID.
+ Template Name
@@ -30435,7 +31824,7 @@ Parameters:
- Updated connection data.
+ Updated Email Template data.
@@ -30522,15 +31911,15 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateConnection(params, data, function (err, connection) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -30542,14 +31931,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update Guardian's factor provider
@@ -30585,7 +31974,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Factor provider parameters.
@@ -30690,7 +32079,7 @@ Parameters:
- Updated email provider data.
+ Updated Factor provider data.
@@ -30777,12 +32166,11 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
console.log(provider);
});
@@ -30795,14 +32183,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update Guardian Factor
@@ -30838,7 +32226,7 @@ u
Source:
Parameters:
- Email Template parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Template Name
-
-
-
-
-
-
-
-
+ Factor parameters.
@@ -30994,7 +32331,7 @@ Parameters:
- Updated Email Template data.
+ Updated factor data.
@@ -31081,15 +32418,10 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
- if (err) {
- // Handle error.
- }
-
- console.log(emailTemplate.from); // 'new@email.com'
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
});
@@ -31101,14 +32433,14 @@ Example
- updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
- Update Guardian's factor provider
+ Update Guardian enrollment and verification factor templates
@@ -31144,7 +32476,7 @@ u
Source:
Parameters:
- Factor provider parameters.
+ Factor parameters.
@@ -31249,7 +32581,7 @@ Parameters:
- Updated Factor provider data.
+ Updated factor templates data.
@@ -31336,12 +32668,11 @@ Returns:
Example
- management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
- messaging_service_sid: 'XXXXXXXXXXXXXX',
- auth_token: 'XXXXXXXXXXXXXX',
- sid: 'XXXXXXXXXXXXXX'
-}, function (err, provider) {
- console.log(provider);
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -31353,14 +32684,14 @@ Example
- updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update Guardian Factor
+ Update the Guardian phone factor's message types
@@ -31396,7 +32727,7 @@ u
Source:
Parameters:
- Factor parameters.
+ Parameters.
@@ -31501,7 +32832,58 @@ Parameters:
- Updated factor data.
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
@@ -31588,8 +32970,8 @@ Returns:
Example
- management.updateGuardianFactor({ name: 'sms' }, {
- enabled: true
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
}, function (err, factor) {
console.log(factor);
});
@@ -31603,14 +32985,14 @@ Example
- updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update Guardian enrollment and verification factor templates
+ Update the Guardian phone factor's selected provider
@@ -31646,7 +33028,7 @@ Source:
Parameters:
- Factor parameters.
+ Parameters.
@@ -31751,7 +33133,58 @@ Parameters:
- Updated factor templates data.
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
@@ -31838,11 +33271,10 @@ Returns:
Example
- management.updateGuardianFactorTemplates({ name: 'sms' }, {
- enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
- verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
-}, function (err, templates) {
- console.log(templates);
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -31854,14 +33286,14 @@ Example
- updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the Guardian phone factor's message types
+ Update enabled Guardian policies
@@ -31897,7 +33329,7 @@ Source:
Parameters:
-Object
+Array.<String>
@@ -32002,58 +33434,7 @@ Parameters:
- Updated selected provider data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- message_types
-
-
-Array.<String>
-
-
-
-
-
-
-
-
-
-
- Message types (only "sms" and "voice" are supported).
-
-
-
-
-
-
-
-
+ Policies to enable. Empty array disables all policies.
@@ -32140,10 +33521,10 @@ Returns:
Example
- management.updateGuardianPhoneFactorMessageTypes({}, {
- message_types: ['sms', 'voice']
-}, function (err, factor) {
- console.log(factor);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -32155,14 +33536,14 @@ Example
- updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update the Guardian phone factor's selected provider
+ Update an existing hook.
@@ -32198,7 +33579,7 @@ Source:
Parameters:
- Parameters.
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated selected provider data.
+ Hook parameters.
@@ -32329,7 +33676,7 @@ Parameters:
- providerid
@@ -32346,7 +33693,7 @@ Parameters:
- Name of the selected provider
+ Hook ID.
@@ -32361,222 +33708,6 @@ Parameters:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.updateGuardianPhoneFactorSelectedProvider({}, {
- provider: 'twilio'
-}, function (err, factor) {
- console.log(factor);
-});
-
-
-
-
-
-
-
-
-
-
- updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Update enabled Guardian policies
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters.
-
-
-
-
-
-
dataParameters:
-Array.<String>
+Object
@@ -32604,7 +33735,7 @@ Parameters:
- Policies to enable. Empty array disables all policies.
+ Updated hook data.
@@ -32691,10 +33822,14 @@ Returns:
Example
- management.updateGuardianPolicies({}, [
- 'all-applications'
-], function (err, policies) {
- console.log(policies);
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(hook.name); // 'my-hook'.
});
@@ -32706,7 +33841,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -32749,7 +33884,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -32993,13 +34128,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -33011,14 +34146,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateLogStream(params, data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update an existing Log Stream.
@@ -33054,7 +34189,7 @@ upda
Source:
Parameters:
- Hook parameters.
+ Rule parameters.
@@ -33168,7 +34303,7 @@ Parameters:
- Hook ID.
+ Rule ID.
@@ -33210,7 +34345,7 @@ Parameters:
- Secrets key/value pairs
+ Updated rule data.
@@ -33297,14 +34432,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ var params = { id: LOG_STREAM_ID };
+var data = { name: 'my-log-stream'};
+management.updateLogStream(params, data, function (err, logStream) {
if (err) {
// Handle error.
}
- console.log(secrets)
+ console.log(logStream.name); // 'my-log-stream'.
});
@@ -33359,7 +34494,7 @@ updat
Source:
u
Source:
updateRole<
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 3e3926033..1ad0348d7 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
index 1b42ff03e..f6696c13f 100644
--- a/docs/module-management.MigrationsManager.html
+++ b/docs/module-management.MigrationsManager.html
@@ -24,7 +24,7 @@
@@ -885,7 +885,7 @@ Example
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index 26e8169dc..d8bf81455 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 3dcb42b67..cc562d156 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index 31be96ad8..0f5ac3241 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new Re
Source:
Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 95eb872d3..809098c7a 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index bb0f85d15..e1a053369 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 9bdb7dbaa..fe13b6f23 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 4d3b71eac..144488d99 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c79e3f5d3..0ce75ca62 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 853e1f623..6de07e280 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index d0a62061c..ebe620c70 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 323ccc179..c384bd273 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ca03b2481..9b220aea8 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -104,6 +104,9 @@ Classes
LogsManager
+ LogStreamsManager
+
+
ManagementClient
@@ -171,7 +174,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 77f91f5f3..573eebf8f 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -118,7 +118,7 @@ (static)
Source:
(static) Source:
(static)
Source:
(static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index a1ba347f4..edc1739df 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -39,8 +39,7 @@ utils.js
- var Promise = require('bluebird');
-var pkg = require('../package.json');
+ var pkg = require('../package.json');
/**
* @module utils
@@ -141,7 +140,7 @@ utils.js
diff --git a/package.json b/package.json
index c6af84938..d679fad74 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.27.1",
+ "version": "2.28.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [