APIs

Show:

A token representing a user identified by a user name and password

Constructor

UserNameIdentityToken

(
  • options
)

Parameters:

  • options Object
    • [policyId] String optional

      The policy id specified in a user token policy for the endpoint being used.

    • [userName] String optional

      The user name

    • [password] ByteString optional

      The password encrypted with the server certificate.

    • [encryptionAlgorithm] String optional

      The algorithm used to encrypt the password.

Methods

binaryStoreSize

() Number

Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean

verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

encryptionAlgorithm

String

The algorithm used to encrypt the password.

password

ByteString

The password encrypted with the server certificate.

policyId

String

The policy id specified in a user token policy for the endpoint being used.