Class default

UserManagerAPI implements the user manager interface and is the concrete implementation of the api end point.

Hierarchy

  • default

Implements

Constructors

constructor

Properties

NAME VERSION _info _transport NAME VERSION

Methods

addUser disableUser enableUser removeUser resetPassword setPassword userInfo

Constructors

constructor

Properties

NAME

NAME: string = "UserManager"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

Static NAME

NAME: string = "UserManager"

Static VERSION

VERSION: number = 2

Methods

addUser

  • AddUser adds a user with a username, and either a password or a randomly generated secret key which will be returned.

    Parameters

    Returns Promise<AddUserResults>

disableUser

  • DisableUser disables one or more users. If the user is already disabled, the action is considered a success.

    Parameters

    Returns Promise<ErrorResults>

enableUser

  • EnableUser enables one or more users. If the user is already enabled, the action is considered a success.

    Parameters

    Returns Promise<ErrorResults>

removeUser

  • RemoveUser permanently removes a user from the current controller for each entity provided. While the user is permanently removed we keep it's information around for auditing purposes. TODO(redir): Add information about getting deleted user information when we add that capability.

    Parameters

    Returns Promise<ErrorResults>

resetPassword

  • ResetPassword resets password for supplied users by invalidating current passwords (if any) and generating new random secret keys which will be returned. Users cannot reset their own password.

    Parameters

    Returns Promise<AddUserResults>

setPassword

userInfo

Settings

Member Visibility

Theme

Generated using TypeDoc