botas-express
    Preparing search index...

    Interface BotAppOptions

    Options for BotApp.

    Extends the core BotApplicationOptions with Express-specific settings for port, route path, and auth toggle.

    interface BotAppOptions {
        clientId?: string;
        clientSecret?: string;
        tenantId?: string;
        token?: (scope: string, tenantId: string) => Promise<string>;
        managedIdentityClientId?: "system" | string & Record<never, never>;
        port?: number;
        path?: string;
        auth?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clientId? clientSecret? tenantId? token? managedIdentityClientId? port? path? auth?

    Properties

    clientId?: string

    Application (client) ID.

    clientSecret?: string

    Client secret.

    tenantId?: string

    Tenant ID.

    token?: (scope: string, tenantId: string) => Promise<string>

    Custom token factory. When provided, called instead of MSAL for every token acquisition.

    managedIdentityClientId?: "system" | string & Record<never, never>

    Managed identity client ID for federated identity credentials. Use "system" for system-assigned managed identity.

    port?: number

    Port to listen on. Defaults to the PORT env var or 3978.

    path?: string

    Path for the messages endpoint. Defaults to "/api/messages".

    auth?: boolean

    Whether to enable inbound JWT auth. Defaults to true when CLIENT_ID is configured, false otherwise.

    Settings

    Member Visibility

    On This Page

    Properties