Interface SecurityOptions

Specifies security options for the client.

interface SecurityOptions {
    disableServerCertificateVerification?: boolean;
    trustOnlyCapella?: boolean;
    trustOnlyCertificates?: string[];
    trustOnlyPemFile?: string;
    trustOnlyPemString?: string;
    trustOnlyPlatform?: boolean;
}

Properties

disableServerCertificateVerification? trustOnlyCapella? trustOnlyCertificates? trustOnlyPemFile? trustOnlyPemString? trustOnlyPlatform?

Properties

Optional disableServerCertificateVerification

disableServerCertificateVerification?: boolean

If disabled, SDK will trust any certificate regardless of validity. Should not be disabled in production environments.

Optional trustOnlyCapella

trustOnlyCapella?: boolean

Specifies the SDK will only trust the Capella CA certificate(s).

Optional trustOnlyCertificates

trustOnlyCertificates?: string[]

Specifies the SDK will only trust the PEM-encoded certificate(s) specified.

Optional trustOnlyPemFile

trustOnlyPemFile?: string

Specifies the SDK will only trust the PEM-encoded certificate(s) at the specified file path.

Optional trustOnlyPemString

trustOnlyPemString?: string

Specifies the SDK will only trust the PEM-encoded certificate(s) in the specified string.

Optional trustOnlyPlatform

trustOnlyPlatform?: boolean

Specifies the SDK will only trust the platform certificate(s).

Settings

Member Visibility

Theme

On This Page

disableServerCertificateVerificationtrustOnlyCapellatrustOnlyCertificatestrustOnlyPemFiletrustOnlyPemStringtrustOnlyPlatform