The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    UserNameIdentityToken Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-session\index.js:47
    Module: services.session

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

    Constructor

    UserNameIdentityToken

    (
    • options
    )

    Defined in packages\node-opcua-service-session\index.js:47

    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

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

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

    Returns:

    Number:

    decode

    (
    • stream
    • [option]
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_UserNameIdentityToken.js:103

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_UserNameIdentityToken.js:89

    encode the object into a binary stream

    Parameters:

    isValid

    () Boolean

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String:

    Properties

    encryptionAlgorithm

    String

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_UserNameIdentityToken.js:71

    The algorithm used to encrypt the password.

    password

    ByteString

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_UserNameIdentityToken.js:64

    The password encrypted with the server certificate.

    policyId

    String

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_UserNameIdentityToken.js:50

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