Interface SeclaiOptions

Configuration for the Seclai client.

interface SeclaiOptions {
    accessToken?: string | AccessTokenProvider;
    accountId?: string;
    apiKey?: string;
    apiKeyHeader?: string;
    autoRefresh?: boolean;
    baseUrl?: string;
    configDir?: string;
    defaultHeaders?: Record<string, string>;
    fetch?: FetchLike;
    profile?: string;
}

Properties

accessToken? accountId? apiKey? apiKeyHeader? autoRefresh? baseUrl? configDir? defaultHeaders? fetch? profile?

Properties

OptionalaccessToken

accessToken?: string | AccessTokenProvider

Static bearer access token or a provider function that returns one. Mutually exclusive with apiKey.

OptionalaccountId

accountId?: string

Target organization account ID. Sent as X-Account-Id header. Overrides the profile's sso_account_id when using SSO auth.

OptionalapiKey

apiKey?: string

API key used for authentication. Defaults to process.env.SECLAI_API_KEY when available.

OptionalapiKeyHeader

apiKeyHeader?: string

Header name to use for the API key. Defaults to x-api-key.

OptionalautoRefresh

autoRefresh?: boolean

Whether to auto-refresh expired SSO tokens. Defaults to true. Set to false in environments that should not write to disk.

OptionalbaseUrl

baseUrl?: string

API base URL. Defaults to process.env.SECLAI_API_URL when available, else SECLAI_API_URL.

OptionalconfigDir

configDir?: string

Override the config directory path (default: SECLAI_CONFIG_DIR env var or ~/.seclai/).

OptionaldefaultHeaders

defaultHeaders?: Record<string, string>

Extra headers to include on every request.

Optionalfetch

fetch?: FetchLike

Optional fetch implementation for environments without a global fetch.

Optionalprofile

profile?: string

SSO profile name to load from ~/.seclai/config. Defaults to process.env.SECLAI_PROFILE, then "default".

Settings

Member Visibility

On This Page

Properties