Class UserManager

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

Hierarchy

UserManager

Index

Methods

Methods

dropGroup

dropGroup(groupName: string, options?: DropGroupOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/usermanager.ts:1028
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>

dropUser

dropUser(username: string, options?: DropUserOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/usermanager.ts:804
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>

getAllGroups

getAllGroups(options?: GetAllGroupsOptions, callback?: NodeCallback<Group[]>): Promise<Group[]>

- Defined in lib/usermanager.ts:939
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[]>

getAllUsers

getAllUsers(options?: GetAllUsersOptions, callback?: NodeCallback<UserAndMetadata[]>): Promise<UserAndMetadata[]>

- Defined in lib/usermanager.ts:713
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[]>

getGroup

getGroup(groupName: string, options?: GetGroupOptions, callback?: NodeCallback<Group>): Promise<Group>

- Defined in lib/usermanager.ts:893
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>

getRoles

getRoles(options?: GetRolesOptions, callback?: NodeCallback<Role[]>): Promise<Role[]>

- Defined in lib/usermanager.ts:848
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[]>

getUser

getUser(username: string, options?: GetUserOptions, callback?: NodeCallback<UserAndMetadata>): Promise<UserAndMetadata>

- Defined in lib/usermanager.ts:666
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>

upsertGroup

upsertGroup(group: IGroup, options?: UpsertGroupOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/usermanager.ts:984
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>

upsertUser

upsertUser(user: IUser, options?: UpsertUserOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/usermanager.ts:759
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>

Generated using TypeDoc