ClientGrantsManager

management. ClientGrantsManager

ClientGrantsManager Auth0 Client Grants Manager.

See Client Grants

Constructor

new ClientGrantsManager(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 Client Grants 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 grant.

Source:
Parameters:
Name Type Attributes Description
data Object

The client data object.

cb function <optional>

Callback function.

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

  // Client grant created.
});

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

Delete an Auth0 client grant.

Source:
Parameters:
Name Type Attributes Description
params Object

Client parameters.

Name Type Description
id String

Client grant ID.

cb function <optional>

Callback function.

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

  // Grant deleted.
});

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

Get all Auth0 Client Grants.

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

Client Grants 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.clientGrants.getAll(params, function (err, grants) {
  console.log(grants.length);
});

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

Update an Auth0 client grant.

Source:
Parameters:
Name Type Attributes Description
params Object

Client parameters.

Name Type Description
id String

Client grant ID.

data Object

Updated client data.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
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);
});