@health-samurai/aidbox-client
    Preparing search index...

    Type Alias AuthorizeConfig

    Configuration accepted by authorize.

    Standalone vs EHR launch is determined by inspecting launchUrl: if it carries iss and launch query parameters the request is treated as an EHR launch and those values override iss/launch from config.

    type AuthorizeConfig = {
        iss?: string;
        launch?: string;
        clientId: string;
        scope: string;
        redirectUri: string;
        clientSecret?: string;
        pkceMode?: "ifSupported" | "required" | "disabled";
        issMatch?: string | RegExp | ((iss: string) => boolean);
        launchUrl?: string | URL;
        wellKnownRequestOptions?: RequestInit;
    }
    Index

    Properties

    iss? launch? clientId scope redirectUri clientSecret? pkceMode? issMatch? launchUrl? wellKnownRequestOptions?

    Properties

    iss?: string

    FHIR server base URL. Required for standalone launch; ignored if present in launchUrl query.

    launch?: string

    EHR launch parameter. Usually comes from launchUrl query, not config.

    clientId: string

    OAuth 2.0 client identifier.

    scope: string

    Space-separated scope string. launch scope is auto-appended for EHR launches if missing.

    redirectUri: string

    Absolute redirect URI registered with the authorization server.

    clientSecret?: string

    Confidential client secret (server-side only). Not persisted in pending or session; pass it again to token refresh/revocation helpers.

    pkceMode?: "ifSupported" | "required" | "disabled"

    PKCE behavior.

    ifSupported (default) — enable PKCE iff server advertises S256 in code_challenge_methods_supported. required — throw if S256 is not advertised. disabled — never use PKCE.

    issMatch?: string | RegExp | ((iss: string) => boolean)

    Optional allow-list for the resolved iss, guarding against arbitrary-iss CSRF.

    launchUrl?: string | URL

    Full URL of the current launch request — used to extract iss and launch from query parameters.

    wellKnownRequestOptions?: RequestInit

    Pass-through RequestInit for the discovery request.

    Settings

    Member Visibility

    On This Page

    Properties