Class PCUsersManager

PCSDK Users Manager

Index

Constructors

Methods

activate delete getById importUser listStorage register store webauthnRegister getInstance

Constructors

constructor

new PCUsersManager(): PCUsersManager
Returns PCUsersManager
- Defined in PCUsersManager.js:37

Methods

activate

activate(user: PCUser, activationCode: string): Promise<void>
Activates the PCUser with provided activation code. Should be called immediately after PCUsersManager#importUser if PCUser#isActivated returns false.
Parameters
- user: PCUser
  Target PCUser object
- activationCode: string
  Activation code
Returns Promise<void>
Throws
- Defined in PCUsersManager.js:283

delete

delete(user: PCUser, password: string): Promise<void>
Removes PCUser from the storage.
Parameters
- user: PCUser
  Target PCUser object
- password: string
  Rutoken password
Returns Promise<void>
Throws
- Defined in PCUsersManager.js:829

getById

getById(userId: string): Promise<PCUser>
Returns PCUser from storage by its id
Parameters
- userId: string
  ID of user
Returns Promise<PCUser>
PCUser object

Throws
- Defined in PCUsersManager.js:766

importUser

importUser(source: string | PCUserJSON, deviceId: number): Promise<PCUser>
Create PCUserJSON by input source (Deep Link value, QR-code value) and deviceId
Parameters
- source: string | PCUserJSON
  User data
- deviceId: number
  Device id
Returns Promise<PCUser>
Throws
- Defined in PCUsersManager.js:84

listStorage

listStorage(): Promise<PCUser[]>
List of PCUser in the storage

Returns Promise<PCUser[]>
array of PCUser objects

Throws
- Defined in PCUsersManager.js:700

register

register(user: PCUser, password: string): Promise<string>
Register PCUser on PCSDK Server
Parameters
- user: PCUser
  Target PCUser object
- password: string
  User password
Returns Promise<string>
Throws
- Defined in PCUsersManager.js:429

store

store(
    user: PCUser,
    keyName: string,
    password: string,
    useBiometry: boolean,
): Promise<void>
Stores a new PCUser an existing object in storage.
Parameters
- user: PCUser
  Target PCUser object
- keyName: string
  Key name
- password: string
  Rutoken password
- useBiometry: boolean
  Use biometry
Returns Promise<void>
Throws
- Defined in PCUsersManager.js:562

webauthnRegister

webauthnRegister(user: PCUser): Promise<void>
Registers WebAuthn authenticator for the provided PCUser.
Parameters
- user: PCUser
  Target PCUser object
Returns Promise<void>
- Defined in PCUsersManager.js:376

`Static`getInstance

getInstance(): PCUsersManager
Singleton instance getter

Returns PCUsersManager
- Defined in PCUsersManager.js:45