Setu-TS
    Preparing search index...

    Interface ISecretManager

    Secret manager backed by a provider (AWS KMS, GCP Secret Manager, Azure Key Vault, HashiCorp Vault, or environment variables in development).

    Secrets must never be logged; the logger redacts known secret fields (AI_GUIDELINES §13.3).

    const secrets = ctx.services.get<ISecretManager>(CAPABILITIES.SECRETS);
    const dbPassword = await secrets.get('database/password');

    0.1.0

    interface ISecretManager {
        get(name: string): Promise<string>;
        has(name: string): Promise<boolean>;
        rotate(name: string, value: string): Promise<void>;
    }

    Implemented by

    Index
    get has rotate

    • Retrieves a secret.

      Parameters

      • name: string

        Secret name (provider-specific path syntax)

      Returns Promise<string>

      The secret value

      If the secret does not exist or access is denied

    • Reports whether a secret exists.

      Parameters

      • name: string

        Secret name

      Returns Promise<boolean>

      true if the secret exists and is accessible

    • Rotates a secret to a new value.

      Parameters

      • name: string

        Secret name

      • value: string

        The new secret value

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods