Class UserManager

UserManager is an interface which enables the management of users, groups and roles for the cluster.

Index

Methods

changePassword dropGroup dropUser getAllGroups getAllUsers getGroup getRoles getUser upsertGroup upsertUser

Methods

changePassword

changePassword(newPassword, options?, callback?): Promise<void>
Change password for the currently authenticatd user.
Parameters
- newPassword: string
  The new password to be applied.
- Optional options: ChangePasswordOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/usermanager.ts:762

dropGroup

dropGroup(groupName, options?, callback?): Promise<void>
Drops an existing group.
Parameters
- groupName: string
  The name of the group to drop.
- Optional options: DropGroupOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/usermanager.ts:1026

dropUser

dropUser(username, options?, callback?): Promise<void>
Drops an existing user.
Parameters
- username: string
  The username of the user to drop.
- Optional options: DropUserOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/usermanager.ts:812

getAllGroups

getAllGroups(options?, callback?): Promise<Group[]>
Returns a list of all existing groups.
Parameters
- Optional options: GetAllGroupsOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<Group[]>
  A node-style callback to be invoked after execution.
Returns Promise<Group[]>
- Defined in lib/usermanager.ts:941

getAllUsers

getAllUsers(options?, callback?): Promise<UserAndMetadata[]>
Returns a list of all existing users.
Parameters
- Optional options: GetAllUsersOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<UserAndMetadata[]>
  A node-style callback to be invoked after execution.
Returns Promise<UserAndMetadata[]>
- Defined in lib/usermanager.ts:675

getGroup

getGroup(groupName, options?, callback?): Promise<Group>
Returns a group by it's name.
Parameters
- groupName: string
  The name of the group to retrieve.
- Optional options: GetGroupOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<Group>
  A node-style callback to be invoked after execution.
Returns Promise<Group>
- Defined in lib/usermanager.ts:897

getRoles

getRoles(options?, callback?): Promise<Role[]>
Returns a list of roles available on the server.
Parameters
- Optional options: GetRolesOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<Role[]>
  A node-style callback to be invoked after execution.
Returns Promise<Role[]>
- Defined in lib/usermanager.ts:854

getUser

getUser(username, options?, callback?): Promise<UserAndMetadata>
Returns a specific user by their username.
Parameters
- username: string
  The username of the user to fetch.
- Optional options: GetUserOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<UserAndMetadata>
  A node-style callback to be invoked after execution.
Returns Promise<UserAndMetadata>
- Defined in lib/usermanager.ts:630

upsertGroup

upsertGroup(group, options?, callback?): Promise<void>
Creates or updates an existing group.
Parameters
- group: IGroup
  The group to update.
- Optional options: UpsertGroupOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/usermanager.ts:984

upsertUser

upsertUser(user, options?, callback?): Promise<void>
Creates or updates an existing user.
Parameters
- user: IUser
  The user to update.
- Optional options: UpsertUserOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/usermanager.ts:719