Class UserManager

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

Hierarchy

  • UserManager

Methods

  • 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>

  • 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>

  • 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>

  • Returns a list of all existing groups.

    Parameters

    Returns 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>

  • 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[]>

  • 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>

  • 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>

  • 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