@mcp-z/client
    Preparing search index...

    Interface OAuthFlowOptions

    Options for OAuth authorization flow

    interface OAuthFlowOptions {
        allowLoopback?: boolean;
        authorizationResponseIssSupported?: boolean;
        headless?: boolean;
        issuer: string;
        logger?: Logger;
        pkce?: boolean;
        port: number;
        redirectUri?: string;
        resource: string;
        scopes?: string[];
        signal?: AbortSignal;
        timeout?: number;
    }
    Index
    allowLoopback? authorizationResponseIssSupported? headless? issuer logger? pkce? port redirectUri? resource scopes? signal? timeout?
    allowLoopback?: boolean

    Loopback trust grant for the token endpoint fetch (SSRF mitigation - see src/auth/discovery-fetch.ts). Compute this from the MCP server the caller is actually talking to, never from tokenEndpoint itself (which is typically sourced from remote-controlled AS metadata). Defaults to false.

    authorizationResponseIssSupported?: boolean

    Whether the authorization server advertises authorization_response_iss_parameter_supported (RFC 9207)

    headless?: boolean

    Headless mode (don't open browser)

    issuer: string

    Issuer identifier discovered before the flow starts; the iss in the authorization response must match it (RFC 9207)

    logger?: Logger

    Optional logger for debug output (defaults to singleton logger)

    pkce?: boolean

    Enable PKCE (RFC 7636) - recommended for all clients, required for public clients

    port: number

    Port for OAuth callback listener (required - use get-port to find available port)

    redirectUri?: string

    Redirect URI for OAuth callback (optional - will be built from port if not provided)

    resource: string

    Canonical resource server URI, sent as resource on the authorization, token, and refresh requests (RFC 8707)

    scopes?: string[]

    OAuth scopes to request

    signal?: AbortSignal

    Cancels an in-progress authorization and closes its callback listener.

    timeout?: number

    Timeout for callback (milliseconds)

    Settings
    Member Visibility

    On This Page
    Properties