DOIP Client Library - JavaScript Version
    Preparing search index...

    Class PrivateKeyAuthenticationInfo

    Used for authenticating using a private key.

    const clientId = '20.500.123/2';
    const jwk = {
        kty: "RSA",
        n: "k31...",
        e: "AQAB",
        d: "NEY...",
        p: "vR9...",
        q: "x6I...",
        dp: "plB...",
        dq: "oqp...",
        qi: "s7M..."
    };
    const authentication = new PrivateKeyAuthenticationInfo(clientId, jwk);
    const serviceInfo = {
        ipAddress: 'localhost',
        port: 9000
    };
    const client = new StandardDoipClient({ authentication, serviceInfo });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    clientId privateKey asUserId?

    Methods

    getClientId getPrivateKey getAuthentication createBearerToken generateJti

    Constructors

    • Constructs a PrivateKeyAuthenticationInfo.

      Parameters

      • clientId: string

        Client ID for this private key

      • privateKey: JsonWebKey

        Private key to use to generate authentication for requests, in JSON Web Key format

      • OptionalasUserId: string

        If present, instructs the DOIP service to perform operations as this user

      Returns PrivateKeyAuthenticationInfo

    Properties

    clientId: string
    privateKey: JsonWebKey
    asUserId?: string

    Methods

    • Returns the clientId property to be used in DOIP requests made with this AuthenticationInfo.

      Returns undefined | string

    • Returns JsonWebKey

    • Returns (async) the authentication property to be used in DOIP requests made with this AuthenticationInfo.

      Returns Promise<Json>

    • Returns Promise<string>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods