Class PCUser

constructor

• new PCUser(props?: Partial<PCUser>): PCUser

  Constructor with default values

  Parameters

  • Optionalprops: Partial<PCUser> = {}

  Returns PCUser

creationDate

deviceId

encryptedKey

expirationTimestamp

extAuthAvailableMethods

hasBiometry

isDelayed

kAuth

kekDigits

keyContent

keyFlags

keyId

keyIndex

keyName

kHmac

onlineCredentials

pcApiVersion

pcExternalUrl

pcKeyVersion

privateKey

publicKey

salt

systemId

systemName

systemSettings

type

userId

getApiVersion

• getApiVersion(): number | null

  Returns level of API which is used to interact with PC Server

  Returns number | null

  API version or 0 if it is unknown

getDeviceId

• getDeviceId(): number | null

  Get user's rutoken connected device Id

  Returns number | null

  User's rutoken connected device Id

getExpirationDate

• getExpirationDate(): Date

  Get user's expiration date

  Returns Date

  User's keys expiration date

getExtAuthAvailableMethods

• getExtAuthAvailableMethods(): string[] | null

  Get Extended authentication methods list for the User

  Returns string[] | null

  Extended authentication methods list

getKeyIndex

• getKeyIndex(): number | null

  Returns index of the symmetric key. The indexes start at 1. That is, "1" is assigned for the first symmetric key generated by the sever. "0" means that the key has no index. All the PCUsers with API version prior to 5 have zero key index

  Returns number | null

  Actual key index or 0 if it is not assigned

getKeyName

• getKeyName(): string

  Get user's key name

  Returns string

  User's key name

getKeyVersion

• getKeyVersion(): number

  Get PCSDK key version

  Returns number

  Version of the key

getPCExternalUrl

• getPCExternalUrl(): string

  Get PCSDK External Server URL

  Returns string

  PCSDK External Server URL

getPublicKey

• getPublicKey(): string

  Get User's public key in ASN.1 format (in hex)

  Returns string

  User's public key

getSystemId

• getSystemId(): string

  Get PCSDK System ID

  Returns string

  PCSDK System ID

getSystemName

• getSystemName(): string | null

  Get PCSDK System Name

  Returns string | null

  PCSDK System Name

getType

• getType(): number | null

  Type of the user. Type influences which underlying cryptography algorithms are used -1 for all keys prior to PCUser#getKeyVersion === 6 0 for keys using AES/ECDSA ciphering/signature algorithms (starting PCUser#getKeyVersion === 6) 1 for keys using GOST ciphering/signature algorithms (starting PCUser#getKeyVersion === 6)

  Returns number | null

  User type or null if not set

getUserId

• getUserId(): string

  Get User ID in PCSDK service

  Returns string

  User ID

hasKeyPair

• hasKeyPair(): boolean

  Check if user has generated key pair

  Returns boolean

  true, if key pair exists; false in other case

hasOnlineCredentials

• hasOnlineCredentials(): boolean

  Check if user has Online Credentials keyFlag

  Returns boolean

isActivated

• isActivated(): boolean

  Check if User is activated

  Returns boolean

  Returns true if the user is activated

isWebAuthnAllowed

• isWebAuthnAllowed(): boolean

  Check if user has WebAuthn keyFlag

  Returns boolean

StaticuserFromJSON

• userFromJSON(userData: PCUserJSON): PCUser

  Create a PCUser from internal store JSON

  Parameters

  • userData: PCUserJSON

  Returns PCUser

StaticuserFromStore

• userFromStore(userData: StoreUserData): PCUser | null

  Create a PCUser instance from store.

  Parameters

  • userData: StoreUserData

  Returns PCUser | null