auth0 3.3.0 → 4.0.0-beta.0

package/src/management/BaseManager.js

@@ -1,41 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
-
-class BaseManager {
-  constructor(options) {
-    if (options === null || typeof options !== 'object') {
-      throw new ArgumentError('Must provide manager options');
-    }
-
-    if (options.baseUrl === null || options.baseUrl === undefined) {
-      throw new ArgumentError('Must provide a base URL for the API');
-    }
-
-    if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
-
-    this._options = options;
-  }
-
-  _getRestClient(path) {
-    const options = this._options;
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      proxy: options.proxy,
-      query: { repeatParams: false },
-      includeResponseHeaders: options.includeResponseHeaders,
-    };
-
-    const usersAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}${path}`,
-      clientOptions,
-      options.tokenProvider
-    );
-    return new RetryRestClient(usersAuth0RestClient, options.retry);
-  }
-}
-
-module.exports = BaseManager;

package/src/management/BlacklistedTokensManager.js

@@ -1,67 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * The BlacklistedTokensManager class provides methods to retrieve the list of
- * blacklisted tokens and blacklist new ones..
- */
-class BlacklistedTokensManager extends BaseManager {
-  /**
-   * @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
-   */
-  constructor(options) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * [Auth0 Blacklisted Tokens endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/blacklists/tokens');
-  }
-
-  /**
-   * Blacklist a new token.
-   *
-   * @example
-   * var token = {
-   *  aud: 'aud',
-   *  jti: 'jti'
-   * };
-   *
-   * management.blacklistedTokens.add(token, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Token blacklisted.
-   * });
-   * @param   {object}    token      Token data.
-   * @param   {string}    token.aud  Audience (your app client ID).
-   * @param   {string}    token.jti  The JWT ID claim.
-   * @param   {Function}  [cb]       Callback function.
-   * @returns  {Promise|undefined}
-   */
-  add(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all blacklisted tokens.
-   *
-   * @example
-   * management.blacklistedTokens.getAll(function (err, tokens) {
-   *   console.log(tokens.length);
-   * });
-   * @param   {Function}  [cb]    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-}
-
-module.exports = BlacklistedTokensManager;

package/src/management/BrandingManager.js

@@ -1,250 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Manages settings related to branding.
- */
-class BrandingManager extends BaseManager {
-  /**
-   * @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
-   */
-  constructor(options) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/management/v2#!/Branding Branding endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/branding');
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/management/v2#!/Branding/get_universal_login Branding new universal login template endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.brandingTemplates = this._getRestClient('/branding/templates/universal-login');
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/management/v2#!/Branding/get_branding_theme Branding theme endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.brandingThemes = this._getRestClient('/branding/themes/:id');
-  }
-
-  /**
-   * Update the branding settings.
-   *
-   * @example
-   * management.branding.updateSettings(params, data, function (err, branding) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   * // Updated branding
-   *    console.log(branding);
-   * });
-   * @param   {object}    params            Branding parameters (leavy empty).
-   * @param   {object}    data              Updated branding data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  updateSettings(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Get the branding settings..
-   *
-   * @example
-   * management.branding.getSettings(data, function (err, branding) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   * // Branding
-   *    console.log(branding);
-   * });
-   * @param   {object}    params            Branding parameters.
-   * @param   {object}    data              Branding data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  getSettings(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Get the new universal login template.
-   *
-   * @example
-   * management.branding.getUniversalLoginTemplate(data, function (err, template) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   * // Branding
-   *    console.log(template);
-   * });
-   * @param   {object}    params            Branding parameters (leave empty).
-   * @param   {object}    data              Branding data (leave empty).
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  getUniversalLoginTemplate(...args) {
-    return this.brandingTemplates.get(...args);
-  }
-
-  /**
-   * Set the new universal login template.
-   *
-   * @example
-   * management.branding.setUniversalLoginTemplate(params, data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   * });
-   * @param   {object}    params            Branding parameters (leavy empty).
-   * @param   {object}    data              Branding data (object with template field).
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  setUniversalLoginTemplate(...args) {
-    return this.brandingTemplates.update(...args);
-  }
-
-  /**
-   * Delete the new universal login template (revert to default).
-   *
-   * @example
-   * management.branding.deleteUniversalLoginTemplate(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   * });
-   * @param   {object}    params            Branding parameters (leavy empty).
-   * @param   {object}    data              Branding data (leave empty).
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  deleteUniversalLoginTemplate(...args) {
-    return this.brandingTemplates.delete(...args);
-  }
-
-  /**
-   * Get the new universal login theme by id.
-   *
-   * @example
-   * var params = { id: THEME_ID };
-   *
-   * management.branding.getTheme(params, function (err, theme) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *    // Theme
-   *    console.log(theme);
-   * });
-   * @param   {object}    params            Theme params
-   * @param   {object}    params.id         Theme identifier.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  getTheme(...args) {
-    return this.brandingThemes.get(...args);
-  }
-
-  /**
-   * Get the default new universal login theme.
-   *
-   * @example
-   * management.branding.getDefaultTheme(function (err, theme) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *    // Theme
-   *    console.log(theme);
-   * });
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  getDefaultTheme(...args) {
-    return this.brandingThemes.get(...[{ id: 'default' }].concat(args));
-  }
-
-  /**
-   * Create a new theme.
-   *
-   * @example
-   * management.branding.createTheme(data, function (err, theme) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Theme created.
-   *   console.log(theme);
-   * });
-   * @param   {object}    data     theme data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  createTheme(...args) {
-    return this.brandingThemes.create(...args);
-  }
-
-  /**
-   * Update a theme.
-   *
-   * @example
-   * var data = THEME_OBJ;
-   * var params = { id: THEME_ID };
-   *
-   * management.branding.updateTheme(params, data, function (err, theme) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Theme updated.
-   *   console.log(theme);
-   * });
-   * @param   {object}    params            Theme parameters.
-   * @param   {object}    params.id         Theme identifier.
-   * @param   {object}    data              Updated theme data.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  updateTheme(...args) {
-    return this.brandingThemes.patch(...args);
-  }
-
-  /**
-   * Delete a theme.
-   *
-   * @example
-   * var params = { id: THEME_ID };
-   *
-   * management.branding.deleteTheme(params, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Theme deleted.
-   * });
-   * @param   {object}    params            Theme parameters.
-   * @param   {object}    params.id         Theme identifier.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns    {Promise|undefined}
-   */
-  deleteTheme(...args) {
-    return this.brandingThemes.delete(...args);
-  }
-}
-
-module.exports = BrandingManager;

package/src/management/ClientCredentialsManager.js

@@ -1,112 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * The client credentials class provides a simple abstraction for performing CRUD operations
- * on Auth0 ClientCredentials.
- */
-class ClientCredentialsManager extends BaseManager {
-  /**
-   * @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
-   */
-  constructor(options) {
-    super(options);
-
-    /**
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/clients/:client_id/credentials/:credential_id');
-  }
-
-  /**
-   * Create a new client credential.
-   *
-   * @example
-   * var params = { client_id: CLIENT_ID };
-   *
-   * management.clientCredentials.create(params, data, function (err, credential) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // The credential created.
-   *   console.log({credential});
-   * });
-   * @param   {string}    params.client_id   The client id.
-   * @param   {object}    data               Client Credential data object.
-   * @param   {Function}  [cb]               Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Return a list of credentials for a given client.
-   *
-   * @example
-   * var params = { client_id: CLIENT_ID };
-   *
-   * management.clientCredentials.getAll(params, function (err, credentials) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // A list of credentials associated with that client.
-   *   console.log({credentials});
-   * });
-   * @param   {string}    params.client_id   The client id.
-   * @param   {Function}  [cb]               Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Return a credential for a given client.
-   *
-   * @example
-   * var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
-   *
-   * management.clientCredentials.getById(data, function (err, credential) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // A specific credential associated with that credential.
-   *   console.log({credential});
-   * });
-   * @param   {string}    params.client_id      The client id.
-   * @param   {string}    params.credential_id  The credential id.
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Delete a credential for a given client.
-   *
-   * @example
-   * var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
-   *
-   * management.clientCredentials.delete(params, data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   * });
-   * @param   {string}    params.client_id      The client id.
-   * @param   {string}    params.credential_id  The credential id.
-   * @param   {Function}  [cb]                  Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = ClientCredentialsManager;

package/src/management/ClientGrantsManager.js

@@ -1,124 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Auth0 Client Grants Manager.
- *
- * See {@link https://auth0.com/docs/api/v2#!/Client_Grants Client Grants}
- */
-class ClientGrantsManager extends BaseManager {
-  /**
-   * @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
-   */
-  constructor(options) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the
-     * {@link https://auth0.com/docs/api/v2#!/Client_Grants Auth0 Client Grants endpoint}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/client-grants/:id');
-  }
-
-  /**
-   * Create an Auth0 client grant.
-   *
-   * @example
-   * management.clientGrants.create(data, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Client grant created.
-   * });
-   * @param   {object}    data     The client data object.
-   * @param   {Function}  [cb]     Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Get all Auth0 Client Grants.
-   *
-   * @example <caption>
-   *   This method takes an optional object as first argument that may be used to
-   *   specify pagination settings. If pagination options are not present,
-   *   the first page of a limited number of results will be returned.
-   * </caption>
-   *
-   * // Pagination settings.
-   * var params = {
-   *   per_page: 10,
-   *   page: 0
-   * };
-   *
-   *
-   * management.clientGrants.getAll(params, function (err, grants) {
-   *   console.log(grants.length);
-   * });
-   * @param   {object}    [params]          Client Grants parameters.
-   * @param   {number}    [params.per_page] Number of results per page.
-   * @param   {number}    [params.page]     Page number, zero indexed.
-   * @param   {Function}  [cb]              Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Update an Auth0 client grant.
-   *
-   * @example
-   * var data = {
-   *   client_id: CLIENT_ID,
-   *   audience: AUDIENCE,
-   *   scope: []
-   * };
-   * var params = { id: CLIENT_GRANT_ID };
-   *
-   * management.clientGrants.update(params, data, function (err, grant) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(grant.id);
-   * });
-   * @param   {object}    params     Client parameters.
-   * @param   {string}    params.id  Client grant ID.
-   * @param   {object}    data       Updated client data.
-   * @param   {Function}  [cb]       Callback function.
-   * @returns    {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an Auth0 client grant.
-   *
-   * @example
-   * management.clientGrants.delete({ id: GRANT_ID }, function (err) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   // Grant deleted.
-   * });
-   * @param   {object}    params     Client parameters.
-   * @param   {string}    params.id  Client grant ID.
-   * @param   {Function}  [cb]       Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = ClientGrantsManager;