FileMaker Data API Tools API - v1.8.0
    Preparing search index...

    Interface SecretStoreOptions

    interface SecretStoreOptions {
        fallbackMode?: SecretFallbackMode;
        workspaceState?: Memento;
        machineId?: string;
        logger?: SecretLogger;
        onFallbackEngaged?: (mode: SecretFallbackMode, reason: string) => void;
    }
    Index
    fallbackMode? workspaceState? machineId? logger? onFallbackEngaged?
    fallbackMode?: SecretFallbackMode

    Fallback strategy when vscode.SecretStorage throws or is unavailable.

    • 'vscode-only' (default): rethrow; no fallback (preserves prior behavior)
    • 'workspace-state': obfuscate and persist to Memento; for headless CI / remote agents. The key comes from the machine id, which anyone who can read the Memento on this machine can also read, so this hides secrets from casual viewing only. It is not protection against local access.
    • 'disabled': do not persist any secrets; reads return undefined; writes are no-ops
    workspaceState?: Memento

    Memento used as the workspace-state fallback. Required when fallbackMode === 'workspace-state'.

    machineId?: string

    Stable identifier mixed into the obfuscation key. Defaults to empty string. Pass vscode.env.machineId at the call site so a copied Memento does not open on a different machine. The machine id is not secret, so this does not protect against local access.

    logger?: SecretLogger

    Logger for fallback warnings.

    onFallbackEngaged?: (mode: SecretFallbackMode, reason: string) => void

    Called once per instance when the fallback is first engaged. Inject the toast at the call site.

    Settings
    Member Visibility

    On This Page
    Properties