@opentdf/sdk
    Preparing search index...

    Type Alias OpenTDFOptions

    Defaults and shared settings that are relevant to creating TDF objects.

    type OpenTDFOptions = {
        authProvider?: AuthProvider;
        cryptoService?: CryptoService;
        defaultCreateOptions?: Omit<CreateOptions, "source">;
        defaultReadOptions?: Omit<ReadOptions, "source">;
        disableDPoP?: boolean;
        dpopKeys?: Promise<KeyPair>;
        interceptors?: Interceptor[];
        platformUrl?: string;
        policyEndpoint?: string;
    }
    Index

    Properties

    authProvider? cryptoService? defaultCreateOptions? defaultReadOptions? disableDPoP? dpopKeys? interceptors? platformUrl? policyEndpoint?

    Properties

    authProvider?: AuthProvider

    Auth provider for connections to the policy service and KASes.

    since 0.14.0. Use interceptors with authTokenInterceptor() or authTokenDPoPInterceptor() instead.

    cryptoService?: CryptoService

    Optional custom CryptoService implementation. If not provided, defaults to the browser's native Web Crypto API. This allows injecting HSM-backed or other secure crypto implementations.

    defaultCreateOptions?: Omit<CreateOptions, "source">

    Default settings for 'encrypt' type requests.

    defaultReadOptions?: Omit<ReadOptions, "source">

    Default settings for 'decrypt' type requests.

    disableDPoP?: boolean

    If we want to not send a DPoP token.

    dpopKeys?: Promise<KeyPair>

    Optional keys for DPoP requests to a server. These often must be registered via a DPoP flow with the IdP which is out of the scope of this library.

    interceptors?: Interceptor[]

    Connect RPC interceptors for authentication. Preferred over authProvider. Use authTokenInterceptor() or authTokenDPoPInterceptor() to create interceptors.

    platformUrl?: string

    Platform URL.

    policyEndpoint?: string

    Policy service endpoint.

    Settings

    Member Visibility

    On This Page

    Properties