MonoCloud Authentication SDK
    Preparing search index...

    Interface SignInOptions

    Options used to customize the sign-in flow.

    interface SignInOptions {
        acrValues?: string[];
        appState?: ApplicationState;
        authenticatorHint?: Authenticators;
        display?: DisplayOptions;
        loginHint?: string;
        maxAge?: number;
        mode?: InteractionMode;
        prompt?: Prompt;
        resource?: string;
        returnUrl?: string;
        scopes?: string;
        signUp?: boolean;
        uiLocales?: string;
    }
    Index

    Properties

    acrValues? appState? authenticatorHint? display? loginHint? maxAge? mode? prompt? resource? returnUrl? scopes? signUp? uiLocales?

    Properties

    acrValues?: string[]

    Authentication Context Class Reference (ACR) values requesting specific authentication assurance levels or methods.

    appState?: ApplicationState

    Custom application state preserved across the authentication round-trip.

    The value is provided to the OnSessionCreating hook when the session is constructed.

    authenticatorHint?: Authenticators

    Specifies the preferred authenticator or identity provider to use for sign-in.

    display?: DisplayOptions

    Preferred display mode for the authentication UI.

    loginHint?: string

    Hint identifying the user (for example, an email or username). Used to pre-fill or optimize the sign-in experience.

    "user@example.com"
    maxAge?: number

    Maximum allowed time (in seconds) since the user's last authentication.

    Used to force re-authentication if the time since the last sign-in exceeds this value.

    mode?: InteractionMode

    Determines the interaction mode for the sign-in flow.

    'redirect'
    prompt?: Prompt

    Specifies the desired authentication interaction behavior.

    resource?: string

    Space-separated resources the access token should be scoped to for this specific sign-in.

    Merged with defaultAuthParams.resource and any indicator resources configured on the client.

    returnUrl?: string

    Relative URL to navigate to after sign-in completes.

    scopes?: string

    Space-separated scopes requested from the authorization server for this specific sign-in.

    Merged with defaultAuthParams.scopes and any indicator scopes configured on the client.

    signUp?: boolean

    When true, starts the sign-up (user registration) flow instead of a standard sign-in.

    Equivalent to setting prompt: 'create'. If both are provided, signUp: true wins.

    uiLocales?: string

    Preferred locale(s) for the sign-in UI.

    "en-US"

    Settings

    On This Page

    Properties