API Documentation

Class

UserManager

UserManager

UserManager is an interface which enables the management of users within a cluster.

View Source usermanager.js, line 402

Methods

# async dropGroup(username, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
username string
options Object <optional>
timeout number <optional>
callback DropGroupCallback <optional>

View Source usermanager.js, line 852

CouchbaseError
Promise.<boolean>

# async dropUser(username, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
username string
options Object <optional>
domainName string <optional>
timeout number <optional>
callback DropUserCallback <optional>

View Source usermanager.js, line 600

UserNotFoundError
CouchbaseError
Promise.<boolean>

# async getAllGroups(optionsopt, callbackopt) → {Promise.<Array.<Group>>}

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetAllGroupsCallback <optional>

View Source usermanager.js, line 749

CouchbaseError
Promise.<Array.<Group>>

# async getAllUsers(optionsopt, callbackopt) → {Promise.<Array.<User>>}

Parameters:
Name Type Attributes Description
options Object <optional>
domainName string <optional>
timeout number <optional>
callback GetAllUsersCallback <optional>

View Source usermanager.js, line 484

CouchbaseError
Promise.<Array.<User>>

# async getGroup(groupName, optionsopt, callbackopt) → {Promise.<Group>}

Parameters:
Name Type Attributes Description
groupName string
options Object <optional>
timeout number <optional>
callback GetGroupCallback <optional>

View Source usermanager.js, line 702

GroupNotFoundError
CouchbaseError
Promise.<Group>

# async getRoles(optionsopt, callbackopt) → {Promise.<Array.<RoleAndDescription>>}

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetRolesCallback <optional>

View Source usermanager.js, line 651

CouchbaseError
Promise.<Array.<RoleAndDescription>>

# async getUser(username, optionsopt, callbackopt) → {Promise.<User>}

Parameters:
Name Type Attributes Description
username string
options Object <optional>
domainName string <optional>
timeout number <optional>
callback GetUserCallback <optional>

View Source usermanager.js, line 431

CouchbaseError
Promise.<User>

# async upsertGroup(group, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
group Group
options Object <optional>
timeout number <optional>
callback UpsertGroupCallback <optional>

View Source usermanager.js, line 800

CouchbaseError
Promise.<boolean>

# async upsertUser(user, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
user User
options Object <optional>
domainName string <optional>
timeout number <optional>
callback UpsertUserCallback <optional>

View Source usermanager.js, line 541

CouchbaseError
Promise.<boolean>