var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+/**
+ * @class GrantsManager
+ * Auth0 Grants Manager.
+ *
+ * See {@link https://auth0.com/docs/api/v2#!/Grants Grants}
+ *
+ * @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 GrantsManager = 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 = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Grants Auth0 Grants endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/grants/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getAll
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: 'USER_ID',
+ * client_id: 'CLIENT_ID',
+ * audience: 'AUDIENCE'
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GrantsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method delete
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: 'GRANT_ID',
+ * user_id: 'USER_ID'
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GrantsManager, 'delete', 'resource.delete');
+
+module.exports = GrantsManager;
+RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 81b0a5a0a..2f9d5a3a1 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -345,7 +345,7 @@
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index ec4acfc0a..401e86a61 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index ec4acfc0a..401e86a61 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -158,7 +158,7 @@
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 727dcef3b..d10f1c13a 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 727dcef3b..d10f1c13a 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -424,7 +424,7 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 88599915d..945d78d6c 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 88599915d..945d78d6c 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -286,7 +286,7 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 2cc6f4c80..f64d2a0f6 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 2cc6f4c80..f64d2a0f6 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 65d309b9d..c5d7e9da6 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 65d309b9d..c5d7e9da6 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 15aacbf37..78496dcab 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 15aacbf37..78496dcab 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -632,7 +632,7 @@
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 4975cbc43..3799198a8 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
auth/index.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 4975cbc43..3799198a8 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:
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
diff --git a/docs/index.html b/docs/index.html
index 35675c193..833192586 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 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 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+ management/GrantsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+ GrantsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+ GrantsManager
+Auth0 Grants Manager.
+See Grants
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(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 consuming the
+Auth0 Grants endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an Auth0 grant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grant parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Grant ID.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to delete.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 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:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
Type:
+
+
+
+
+
+grants :GrantsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the grants
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
GrantsManager
+
+
+
+
+
+
+
+
+
@@ -1323,7 +1398,7 @@ guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
ge
Source:
g
Source:
getClientSource:
getCli
Source:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
Example
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The client_id of the grants to retrieve.
+
+
+
+
+
+
+
+
+ audience
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The audience of the grants to retrieve.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
@@ -12133,7 +12612,7 @@
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
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 ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
EmailTemplatesManager
+ GrantsManager
+
+
GuardianManager
@@ -150,7 +153,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 9e941863c..de8d6d96f 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
GrantsManager
+Auth0 Grants Manager. See Grants The client options. The URL of the API. Headers to be included in all requests. Retry Policy Config Provides an abstraction layer for consuming the
+Auth0 Grants endpoint. Options object for the Rest Client instance. Delete an Auth0 grant. Grant parameters. Grant ID. The user_id of the grants to delete. Callback function. Delete an Auth0 grant. Grant parameters. Grant ID. The user_id of the grants to delete. Callback function. Get all Auth0 Grants. Grants parameters. Number of results per page. Page number, zero indexed. true if a query summary must be included in the result, false otherwise. Default false; The user_id of the grants to retrieve. The client_id of the grants to retrieve. The audience of the grants to retrieve. Callback function. Simple abstraction for performing CRUD operations on the grants
+endpoint. Get all Auth0 Grants. Grants parameters. Number of results per page. Page number, zero indexed. true if a query summary must be included in the result, false otherwise. Default false; The user_id of the grants to retrieve. The client_id of the grants to retrieve. The audience of the grants to retrieve. Callback function.
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 57186a500..bcff23394 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 090f03820..4850884f1 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 c8a415528..140924389 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 70edd7e7a..45945c82d 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 8940d287b..9ae700a03 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 9f64551f5..2b1af95ad 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 276f60672..1f8e53332 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 1d5725300..d16a37ce0 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
new file mode 100644
index 000000000..9696f7d60
--- /dev/null
+++ b/docs/management_GrantsManager.js.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+
+
+
+
+management/GrantsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 3afa11710..8b6e44737 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 409665611..74929d905 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -354,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 02b71be8d..5e3528292 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 61a6fa94b..81f2d0d5f 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index fafbb3aca..056216f03 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 439658b62..4273811b1 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 93eae695b..01d16792a 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 6ef638d33..60e18bd43 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 25f65f66b..5cc586f03 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 03451ef26..c9072b7c3 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index e09e07ad9..da1311f7f 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a94ca9567..f4c40428e 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -52,6 +52,7 @@ management/index.js
// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
+var GrantsManager = require('./GrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
@@ -190,6 +191,14 @@ management/index.js
*/
this.clientGrants = new ClientGrantsManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the grants
+ * endpoint.
+ *
+ * @type {GrantsManager}
+ */
+ this.grants = new GrantsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
@@ -703,6 +712,68 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method getGrants
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = {
+ * per_page: 10,
+ * page: 0,
+ * include_totals: true,
+ * user_id: USER_ID,
+ * client_id: CLIENT_ID,
+ * audience: AUDIENCE
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ * console.log(grants.length);
+ * });
+ *
+ * @param {Object} params Grants parameters.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
+ * @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param {String} params.user_id The user_id of the grants to retrieve.
+ * @param {String} params.client_id The client_id of the grants to retrieve.
+ * @param {String} params.audience The audience of the grants to retrieve.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGrants', 'grants.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method deleteGrant
+ * @memberOf module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ * id: GRANT_ID,
+ * user_id: USER_ID
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Grant deleted.
+ * });
+ *
+ * @param {Object} params Grant parameters.
+ * @param {String} params.id Grant ID.
+ * @param {String} params.user_id The user_id of the grants to delete.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteGrant', 'grants.delete');
+
/**
* Create an Auth0 credential.
*
@@ -2302,7 +2373,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 3759ff8a2..cc2c32621 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 64f95eedb..90932c634 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f161a65ee..3649be502 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -414,7 +414,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 9aec2c527..993a84683 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e20079a2c..a3a317708 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index c01be4808..3f2e224de 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 f35ae1e47..9f54e8205 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 cc295c8ec..a569091fd 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 094d54110..e45a51278 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index a14a07f8c..43b5a1cd5 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 0b77f92d1..e534945d0 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 c6a8da76d..4caac30c4 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index c61671616..3a70ea836 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 c87bb56fc..421ed06f7 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 530ab5dcb..e055228b4 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 ecaea5ef5..619a896b8 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
new file mode 100644
index 000000000..c7503b11c
--- /dev/null
+++ b/docs/module-management.GrantsManager.html
@@ -0,0 +1,1524 @@
+
+
+
+
+
+
+
+
+
+GrantsManager
+
+
+
+
+
+
+
+
+ management.
+
+ GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new GrantsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+options
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ baseUrl
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ headers
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+retry
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+
+
+ (inner) clientOptions :Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+Object
+
+
+ Methods
+
+
+
+
+
+
+
+
+
+
+delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+user_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var params = {
+ id: 'GRANT_ID',
+ user_id: 'USER_ID'
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+deleteGrant(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+user_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var params = {
+ id: GRANT_ID,
+ user_id: USER_ID
+};
+
+management.deleteGrant(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Grant deleted.
+});
+
+
+
+
+
+
+
+
+
+
+getAll(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ include_totals
+
+
+
+
+
+
+
+
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+ client_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+audience
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: 'USER_ID',
+ client_id: 'CLIENT_ID',
+ audience: 'AUDIENCE'
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index 59e6fb9d8..c86c3e833 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a8d359bf4..94b44b410 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -1849,7 +1849,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c022c6e50..3acd3f88b 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 843cb3828..7505f6676 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@
+
+
+
+new M
blac
clientGra
clientsSource:
connection
customDo
devi
emailPro
emailTe
Type:
+
+
@@ -1323,7 +1398,7 @@ grants :GrantsManager
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
GrantsManager
+
+
+ guardianSource:
jobsSource:
logsSource:
resour
rulesSource:
rulesConf
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
createCli
crea
creat
cre
Source:
Source:
Source:
c
createRule<
createUser<
deleteA
deleteCli
dele
delet
del
Source:
de
Source:
d
deleteRule<
dele
deleteUser<
exportUser
ge
g
getClient
getCli
getClien
getClients<
getConne
getConn
getCus
getCu
getDaily
g
getEm
Example
+
+
+
+
+
+
getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ include_totals
+
+
+
+
+
+
+
+
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+ client_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+audience
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var params = {
+ per_page: 10,
+ page: 0,
+ include_totals: true,
+ user_id: USER_ID,
+ client_id: CLIENT_ID,
+ audience: AUDIENCE
+};
+
+management.getGrants(params, function (err, grants) {
+ console.log(grants.length);
+});
@@ -12133,7 +12612,7 @@
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
get
getRuleSource:
getRulesSource:
getRul
getT
getUserSource:
getUserLog
getUsersSource:
getUse
importUser
linkUsers
Source:
setRule
unlinkUser
upda
updateCli
upda
updat
up
u
updateRule<
u
updateUser<
upd
ver
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index ff9ee87b1..d54c5c3d0 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 506dcf254..68b038b8a 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 7088c566b..7b3710806 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 502ae2f83..4ed666499 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 b7640c53a..7f9a2d970 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 ce9e4385a..5bd99e37f 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 c659e73ae..1c823a01d 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index ccc194f35..314bbde5f 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.UsersManager.html b/docs/module-management.UsersManager.html
index 33658deef..0a798e1d0 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 138034ca4..7535febd0 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -86,6 +86,9 @@ Classes
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 0a882f6e8..5f35d0d26 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c1d593455..d73697cdf 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index 80138069b..341b38cbc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.15.0",
+ "version": "2.16.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],