ResourceServersManager

management. ResourceServersManager

ResourceServersManager Auth0 Resource Servers Manager.

Resource Servers represents your APIs. You can learn more about this in the API Authorization section of the documentation.

Constructor

new ResourceServersManager(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 Resource Servers endpoint.

Source:
Type:

(inner) clientOptions :Object

Options object for the Rest Client instance.

Source:
Type:
  • Object

Methods

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

Create an API (Resource Server).

Source:
Parameters:
Name Type Attributes Description
data Object

Resource Server data object.

cb function <optional>

Callback function.

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

  // Resource Server created.
});

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

Delete an existing Resource Server.

Source:
Parameters:
Name Type Attributes Description
params Object

Resource Server parameters.

Name Type Description
id String

Resource Server ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.resourceServers.delete({ id: RESOURCE_SERVER_ID }, function (err) {
  if (err) {
    // Handle error.
  }

  // Resource Server deleted.
});

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

Get a Resource Server.

Source:
Parameters:
Name Type Attributes Description
params Object

Resource Server parameters.

Name Type Description
id String

Resource Server ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.resourceServers.get({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
  if (err) {
    // Handle error.
  }

  console.log(resourceServer);
});

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

Get all resource servers.

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

Resource Servers 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.resourceServers.getAll(params, function (err, resourceServers) {
  console.log(resourceServers.length);
});

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

Update an existing resource server.

Source:
Parameters:
Name Type Attributes Description
params Object

Resource Server parameters.

Name Type Description
id String

Resource Server ID.

data Object

Updated Resource Server data.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
var data = { name: 'newResourceServerName' };
var params = { id: RESOURCE_SERVER_ID };

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

  console.log(resourceServer.name);  // 'newResourceServernName'
});