NodeOPCUA API Documentation
    Preparing search index...

    Interface AdvertisedEndpointConfig

    Per-URL security restrictions for advertised endpoints.

    All advertised URLs share the listener's socket: an entry can only make its URL stricter than the main endpoint, and it only binds clients that present that URL (a client presenting the main URL gets the main settings). See documentation/advertised_endpoints.md, "Security Model".

    When advertisedEndpoints contains a config object, the endpoint descriptions generated for that URL use the overridden security settings instead of inheriting from the main endpoint.

    Any field that is omitted falls back to the main endpoint's value.

    advertisedEndpoints: [
        // Public: SignAndEncrypt only, no anonymous
        {
            url: "opc.tcp://public.example.com:4840",
            securityModes: [MessageSecurityMode.SignAndEncrypt],
            allowAnonymous: false
        },
        // Internal: inherits everything from main endpoint
        "opc.tcp://internal:48480"
    ]
    interface AdvertisedEndpointConfig {
        allowAnonymous?: boolean;
        securityModes?: MessageSecurityMode[];
        securityPolicies?: SecurityPolicy[];
        url: string;
        userTokenTypes?: UserTokenType[];
    }
    Index
    allowAnonymous? securityModes? securityPolicies? url userTokenTypes?
    allowAnonymous?: boolean

    false removes anonymous access for this URL (default: inherit from main endpoint); true cannot add it

    securityModes?: MessageSecurityMode[]

    Restrict security modes (default: inherit from main endpoint); modes the main endpoint lacks are ignored

    securityPolicies?: SecurityPolicy[]

    Restrict security policies (default: inherit from main endpoint); policies the main endpoint lacks are ignored

    url: string

    The full endpoint URL, e.g. "opc.tcp://public.example.com:4840"

    userTokenTypes?: UserTokenType[]

    Restrict user token types (default: inherit from main endpoint).

    This list can only restrict the main endpoint list: token types that the main endpoint does not allow are ignored (with a warning).

    note: all URLs of a listener share the same socket and the server cannot verify which URL a client really used, so this restriction guides well-behaved clients but is not an authentication boundary: a client that presents the main URL gets the main list. To enforce a different list, give it its own listener (endpoints: [{ port, userTokenTypes }]).

    Settings
    Member Visibility

    On This Page
    Properties