ClientsManager

management. ClientsManager

ClientsManager Auth0 Clients Manager.

Clients represent applications. You can learn more about this in the Applications section of the documentation.

Constructor

new ClientsManager(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 Clients endpoint.

Source:
Type:

(inner) clientOptions :Object

Options object for the Rest Client instance.

Source:
Type:
  • Object

Methods

create(data, cbopt) → {Promise|undefined}

Create an Auth0 client.

Source:
Parameters:
Name Type Attributes Description
data Object

The client data object.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.clients.create(data, function (err) {
  if (err) {
    // Handle error.
  }

  // Client created.
});

delete(params, cbopt) → {Promise|undefined}

Delete an Auth0 client.

Source:
Parameters:
Name Type Attributes Description
params Object

Client parameters.

Name Type Description
client_id String

Application client ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.clients.delete({ client_id: CLIENT_ID }, function (err) {
  if (err) {
    // Handle error.
  }

  // Client deleted.
});

get(params, cbopt) → {Promise|undefined}

Get an Auth0 client.

Source:
Parameters:
Name Type Attributes Description
params Object

Client parameters.

Name Type Description
client_id String

Application client ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.clients.get({ client_id: CLIENT_ID }, function (err, client) {
  if (err) {
    // Handle error.
  }

  console.log(client);
});

getAll(paramsopt, cbopt) → {Promise|undefined}

Get all Auth0 clients.

Source:
Parameters:
Name Type Attributes Description
params Object <optional>

Clients parameters.

Name Type Attributes Description
per_page Number <optional>

Number of results per page.

page Number <optional>

Page number, zero indexed.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example

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.

// Pagination settings.
var params = {
  per_page: 10,
  page: 0
};

management.clients.getAll(params, function (err, clients) {
  console.log(clients.length);
});

update(params, data, cbopt) → {Promise|undefined}

Update an Auth0 client.

Source:
Parameters:
Name Type Attributes Description
params Object

Client parameters.

Name Type Description
client_id String

Application client ID.

data Object

Updated client data.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
var data = { name: 'newClientName' };
var params = { client_id: CLIENT_ID };

management.clients.update(params, data, function (err, client) {
  if (err) {
    // Handle error.
  }

  console.log(client.name);  // 'newClientName'
});