@grow-codes/infisical - v0.1.2
    Preparing search index...

    Interface InfisicalConfigOptions

    Options accepted by InfisicalConfig (all optional).

    interface InfisicalConfigOptions {
        apiVersion?: "" | ApiVersion;
        auth?: InfisicalAuth;
        clientId?: string;
        clientSecret?: string | Secret;
        connectTimeoutMs?: number;
        environment?: string;
        expandSecretReferences?: boolean;
        headers?: Record<string, string>;
        hooks?: Hooks;
        includeImports?: boolean;
        logger?: ClientLogger;
        organizationSlug?: string;
        projectId?: string;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        revokeOnClose?: boolean;
        secretPath?: string;
        tls?: TlsOptions;
        token?: string | Secret;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    apiVersion?: "" | ApiVersion

    Secrets API version (env GROW_INFISICAL_API_VERSION; default auto: v4, falling back to v3 when v4 is missing; "" means auto).

    Explicit auth method (UniversalAuth, TokenAuth, KubernetesAuth, AwsIamAuth). Wins over token and clientId/clientSecret.

    clientId?: string

    Universal Auth client id (env GROW_INFISICAL_CLIENT_ID, INFISICAL_CLIENT_ID).

    clientSecret?: string | Secret

    Universal Auth client secret (env GROW_INFISICAL_CLIENT_SECRET, INFISICAL_CLIENT_SECRET).

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    environment?: string

    Default environment slug, e.g. dev (env GROW_INFISICAL_ENVIRONMENT, INFISICAL_ENVIRONMENT). Required by secret operations (ConfigError at call time).

    expandSecretReferences?: boolean

    Expand ${…} secret references on read (default true).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    includeImports?: boolean

    Include imported secrets on read (default true).

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    organizationSlug?: string

    Organization slug sent with identity logins (optional, sub-organization logins).

    projectId?: string

    Default project id (env GROW_INFISICAL_PROJECT_ID, INFISICAL_PROJECT_ID).

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    Retry policy or its options.

    revokeOnClose?: boolean

    Revoke an access token obtained by login when the client is closed (env GROW_INFISICAL_REVOKE_ON_CLOSE, default false).

    secretPath?: string

    Default secret path (env GROW_INFISICAL_SECRET_PATH, default /).

    TLS settings.

    token?: string | Secret

    Static access token (machine identity token, user JWT or legacy st. service token), sent as Authorization: Bearer <token> (env GROW_INFISICAL_TOKEN, INFISICAL_TOKEN).

    totalTimeoutMs?: number

    Whole-call timeout in ms including retries and backoff (default 120 000).

    url?: string

    Endpoint base URL.

    userAgentSuffix?: string

    Appended after the standard User-Agent.