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

dropGroup

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

dropUser

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

getAllGroups

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

getAllUsers

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

getGroup

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

getRoles

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

getUser

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

upsertGroup

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

upsertUser

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

Class UserManager

Index

Methods

Methods

changePassword

Parameters

Returns Promise<void>

dropGroup

Parameters

Returns Promise<void>

dropUser

Parameters

Returns Promise<void>

getAllGroups

Parameters

Returns Promise<Group[]>

getAllUsers

Parameters

Returns Promise<UserAndMetadata[]>

getGroup

Parameters

Returns Promise<Group>

getRoles

Parameters

Returns Promise<Role[]>

getUser

Parameters

Returns Promise<UserAndMetadata>

upsertGroup

Parameters

Returns Promise<void>

upsertUser

Parameters

Returns Promise<void>

Settings

On This Page