UsersManager

Example

var params =  { id : 'USER_ID';
var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};

management.users.assignPermissions(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // permissions added.
});

Example

var params =  { id : 'USER_ID';
var data = { "roles" : ["roleId1", "roleID2"]};

management.users.assignRoles(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // roles added.
});

Example

management.users.create(data, function (err) {
  if (err) {
    // Handle error.
  }

  // User created.
});

Example

management.users.delete({ id: USER_ID }, function (err) {
  if (err) {
    // Handle error.
  }

  // User deleted.
});

Example

management.users.deleteAll(function (err) {
  if (err) {
    // Handle error.
  }

  // Users deleted
});

Example

var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };

management.users.deleteMultifactorProvider(params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users accounts unlinked.
});

Example

management.users.get({ id: USER_ID }, function (err, user) {
  console.log(user);
});

Example

This method takes an optional object as first argument that may be used to specify pagination settings and the search query. 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.users.getAll(params, function (err, users) {
  console.log(users.length);
});

Example

This method takes a first argument as the Email address to look for users, and uses the /users-by-email API, not the search API

management.users.getByEmail('email@address', function (err, users) {
  console.log(users);
});

Example

management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
  console.log(enrollments);
});

Example

Get the user information based on the Auth0 access token (obtained during login). Find more information in the API Docs.

auth0.users.getInfo(accessToken, function (err, userInfo) {
  if (err) {
    // Handle error.
  }

  console.log(userInfo);
});

Example

management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
  console.log(permissions);
});

Example

management.users.getRoles({ id: USER_ID }, function (err, roles) {
  console.log(roles);
});

Example

management.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
  console.log(orgs);
});

Example

Gets a link that can be used once to log in as a specific user. Useful for troubleshooting. Find more information in the [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate).

var settings = {
  impersonator_id: '{IMPERSONATOR_ID}',
  protocol: 'oauth2',
  additionalParameters: {}  // Optional additional params.
};

auth0.users.impersonate(userId, settings, function (err, link) {
  if (err) {
    // Handle error.
  }

  console.log(link);
});

Example

management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
  if (err) {
    // Handle error.
  }

  // Invalidated all remembered browsers.
});

Example

var userId = 'USER_ID';
var params = {
  user_id: 'OTHER_USER_ID',
  connection_id: 'CONNECTION_ID'
};

management.users.link(userId, params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users linked.
});

Example

var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };

management.users.logs(params, function (err, logs) {
  if (err) {
    // Handle error.
  }

  console.log(logs);
});

Example

management.users.regenerateRecoveryCode("USER_ID", function (err, result) {
  console.log(result.recovery_code);
});

Example

var params =  { id : 'USER_ID';
var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};

management.users.removePermissions(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // permissions removed.
});

Example

var params =  { id : 'USER_ID';
var data = { "roles" : ["roleId1", "roleID2"]};

management.users.removeRoles(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // roles removed.
});

Example

var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };

management.users.unlink(params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users accounts unlinked.
});

Example

var params = { id: USER_ID };

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

  // Updated user.
  console.log(user);
});

Example

var params = { id: USER_ID };
var metadata = {
  foo: 'bar'
};

management.users.updateAppMetadata(params, metadata, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Updated user.
  console.log(user);
});

Example

var params = { id: USER_ID };
var metadata = {
  address: '123th Node.js Street'
};

management.users.updateUserMetadata(params, metadata, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Updated user.
  console.log(user);
});

Example

var params =  { id : 'USER_ID';
var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};

management.users.assignPermissions(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // permissions added.
});

Example

var params =  { id : 'USER_ID';
var data = { "roles" : ["roleId1", "roleID2"]};

management.users.assignRoles(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // roles added.
});

Example

management.users.create(data, function (err) {
  if (err) {
    // Handle error.
  }

  // User created.
});

Example

management.users.delete({ id: USER_ID }, function (err) {
  if (err) {
    // Handle error.
  }

  // User deleted.
});

Example

management.users.deleteAll(function (err) {
  if (err) {
    // Handle error.
  }

  // Users deleted
});

Example

var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };

management.users.deleteMultifactorProvider(params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users accounts unlinked.
});

Example

management.users.get({ id: USER_ID }, function (err, user) {
  console.log(user);
});

Example

This method takes an optional object as first argument that may be used to specify pagination settings and the search query. 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.users.getAll(params, function (err, users) {
  console.log(users.length);
});

Example

This method takes a first argument as the Email address to look for users, and uses the /users-by-email API, not the search API

management.users.getByEmail('email@address', function (err, users) {
  console.log(users);
});

Example

management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
  console.log(enrollments);
});

Example

Get the user information based on the Auth0 access token (obtained during login). Find more information in the API Docs.

auth0.users.getInfo(accessToken, function (err, userInfo) {
  if (err) {
    // Handle error.
  }

  console.log(userInfo);
});

Example

management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
  console.log(permissions);
});

Example

management.users.getRoles({ id: USER_ID }, function (err, roles) {
  console.log(roles);
});

Example

management.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
  console.log(orgs);
});

Example

Gets a link that can be used once to log in as a specific user. Useful for troubleshooting. Find more information in the [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate).

var settings = {
  impersonator_id: '{IMPERSONATOR_ID}',
  protocol: 'oauth2',
  additionalParameters: {}  // Optional additional params.
};

auth0.users.impersonate(userId, settings, function (err, link) {
  if (err) {
    // Handle error.
  }

  console.log(link);
});

Example

management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
  if (err) {
    // Handle error.
  }

  // Invalidated all remembered browsers.
});

Example

var userId = 'USER_ID';
var params = {
  user_id: 'OTHER_USER_ID',
  connection_id: 'CONNECTION_ID'
};

management.users.link(userId, params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users linked.
});

Example

var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };

management.users.logs(params, function (err, logs) {
  if (err) {
    // Handle error.
  }

  console.log(logs);
});

Example

management.users.regenerateRecoveryCode("USER_ID", function (err, result) {
  console.log(result.recovery_code);
});

Example

var params =  { id : 'USER_ID';
var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};

management.users.removePermissions(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // permissions removed.
});

Example

var params =  { id : 'USER_ID';
var data = { "roles" : ["roleId1", "roleID2"]};

management.users.removeRoles(params, data, function (err, user) {
  if (err) {
    // Handle error.
  }

  // roles removed.
});

Example

var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };

management.users.unlink(params, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Users accounts unlinked.
});

Example

var params = { id: USER_ID };

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

  // Updated user.
  console.log(user);
});

Example

var params = { id: USER_ID };
var metadata = {
  foo: 'bar'
};

management.users.updateAppMetadata(params, metadata, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Updated user.
  console.log(user);
});

Example

var params = { id: USER_ID };
var metadata = {
  address: '123th Node.js Street'
};

management.users.updateUserMetadata(params, metadata, function (err, user) {
  if (err) {
    // Handle error.
  }

  // Updated user.
  console.log(user);
});