Class

UserManager

UserManager

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

View Source usermanager.js, line 250

Methods

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

Parameters:
Name Type Attributes Description
username string
options * <optional>
timeout integer <optional>
callback DropGroupCallback <optional>

View Source usermanager.js, line 659

CouchbaseError
Promise.<boolean>

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

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

View Source usermanager.js, line 427

UserNotFoundError
CouchbaseError
Promise.<boolean>

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

Parameters:
Name Type Attributes Description
options * <optional>
timeout integer <optional>
callback GetAllGroupsCallback <optional>

View Source usermanager.js, line 566

CouchbaseError
Promise.<Array.<Group>>

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

Parameters:
Name Type Attributes Description
options * <optional>
domainName string <optional>
timeout integer <optional>
callback GetAllUsersCallback <optional>

View Source usermanager.js, line 322

CouchbaseError
Promise.<Array.<User>>

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

Parameters:
Name Type Attributes Description
groupName string
options * <optional>
timeout integer <optional>
callback GetGroupCallback <optional>

View Source usermanager.js, line 522

GroupNotFoundError
CouchbaseError
Promise.<Group>

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

Parameters:
Name Type Attributes Description
options * <optional>
timeout integer <optional>
callback GetRolesCallback <optional>

View Source usermanager.js, line 475

CouchbaseError
Promise.<Array.<RoleAndDescription>>

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

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

View Source usermanager.js, line 272

CouchbaseError
Promise.<User>

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

Parameters:
Name Type Attributes Description
group Group
options * <optional>
timeout integer <optional>
callback UpsertGroupCallback <optional>

View Source usermanager.js, line 613

CouchbaseError
Promise.<boolean>

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

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

View Source usermanager.js, line 375

CouchbaseError
Promise.<boolean>