@auth0/nextjs-auth0 - v4.30.0
    Preparing search index...

    Interface StartEnterpriseLoginClientOptions

    Options for the client-side startEnterpriseLogin helper.

    Extends the server StartEnterpriseLoginOptions (so email, authorizationParameters, and returnTo behave identically to the server flavour) and adds the two client-only route overrides the browser needs to reach the SDK's mounted routes.

    interface StartEnterpriseLoginClientOptions {
        authorizationParameters?: AuthorizationParameters;
        email: string;
        federatedDomainRoute?: string;
        loginRoute?: string;
        returnTo?: string;
    }

    Hierarchy (View Summary)

    Index
    authorizationParameters? email federatedDomainRoute? loginRoute? returnTo?
    authorizationParameters?: AuthorizationParameters

    Authorization parameters to be passed to the authorization server.

    email: string

    The user's email address. Its domain is used for Home Realm Discovery to decide whether to route through Auth0, and is passed as login_hint so Auth0 can resolve the enterprise connection and organization. This always wins over any login_hint set in authorizationParameters.

    federatedDomainRoute?: string

    Override the domain-discovery route. Defaults to the NEXT_PUBLIC_FEDERATED_DOMAIN_ROUTE env var or /auth/federated-domain.

    loginRoute?: string

    Override the login route. Defaults to the NEXT_PUBLIC_LOGIN_ROUTE env var or /auth/login.

    returnTo?: string

    The URL to redirect to after a successful login.

    Settings
    Member Visibility

    On This Page
    Properties