Frodo Library - v4.8.5
    Preparing search index...

    Type Alias BrowserLoginOptions

    type BrowserLoginOptions = {
        deploymentType?: string;
        loginClientId?: string;
        loginRedirectUri?: string;
        loginScope?: string;
        promptHandler: BrowserLoginPromptHandler;
        timeoutMs?: number;
        useDeviceFlow?: boolean;
    }
    Index

    Properties

    deploymentType?: string

    Deployment type to authenticate against. Required — unlike getTokens(), there is no AM session yet at the start of a browser login for determineDeploymentType() to probe with, so it can't be auto-detected.

    loginClientId?: string

    Override the built-in OAuth2 client id for the target deployment type.

    loginRedirectUri?: string

    Full, absolute redirect URI to use for browser login, for a client registered with an exact-match redirect URI. Shared with the non-interactive synthetic login flow's own --login-redirect-uri (see state.getAdminClientRedirectUri()) — when omitted here, that value is used as the fallback, exactly like loginClientId already falls back to state.getAdminClientId(). When both are absent, falls through to an auto-generated loopback redirect on an OS-assigned ephemeral port (or, for cloud's built-in client specifically, its one confirmed-fixed redirect URI — see CLOUD_BROWSER_LOGIN_REDIRECT_URI).

    loginScope?: string

    Override the default scope requested for the target deployment type.

    Presents the login step (a URL, or a device code) to the human completing it.

    timeoutMs?: number

    How long to wait for the human to complete the login step.

    useDeviceFlow?: boolean

    Use the OAuth2 Device Authorization Grant instead of a loopback redirect.