@schibsted/account-sdk-browser
    Preparing search index...

    Type Alias LoginOptions

    Options accepted by Account#login and related login URL helpers.

    type LoginOptions = {
        acrValues?:
            | "password"
            | "otp"
            | "sms"
            | "eid-dk"
            | "eid-no"
            | "eid-se"
            | "eid-fi"
            | "eid"
            | "otp-email"
            | string & {};
        locale?: "nb_NO"
        | "fi_FI"
        | "sv_SE"
        | "en_US";
        loginHint?: string;
        maxAge?: number | string;
        oneStepLogin?: boolean;
        originCampaign?: string;
        preferPopup?: boolean;
        prompt?: "select_account" | "login";
        redirectUri?: string;
        scope?: "openid" | string & {};
        state: string;
        tag?: string;
        teaser?: string;
        xDomainId?: string;
        xEnvironmentId?: string;
    }
    Index

    Properties

    acrValues? locale? loginHint? maxAge? oneStepLogin? originCampaign? preferPopup? prompt? redirectUri? scope? state tag? teaser? xDomainId? xEnvironmentId?

    Properties

    acrValues?:
        | "password"
        | "otp"
        | "sms"
        | "eid-dk"
        | "eid-no"
        | "eid-se"
        | "eid-fi"
        | "eid"
        | "otp-email"
        | string & {}

    Authentication Context Class Reference values. If omitted, the default account flow is used. Supported values include password, otp, sms, otp-email, eid, eid-no, eid-se, eid-fi, and eid-dk. Values other than otp-email may be combined as a space-separated string. Verify the AMR (Authentication Methods References) claim in the ID token on your backend if you need to enforce a completed authentication method.

    locale?: "nb_NO" | "fi_FI" | "sv_SE" | "en_US"

    Optional parameter to overwrite client locale setting. New flows supports nb_NO, fi_FI, sv_SE, en_US

    loginHint?: string

    user email or UUID hint

    maxAge?: number | string

    Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated. If last authentication time is more than maxAge seconds in the past, re-authentication will be required. See the OpenID Connect spec section 3.1.2.1 for more information. Prefer a number of seconds; strings remain accepted for legacy callers.

    oneStepLogin?: boolean

    display username and password on one screen. Defaults to false.

    originCampaign?: string

    Campaign identifier for tracking in Pulse

    preferPopup?: boolean

    Should we try to open a popup window? Defaults to false.

    prompt?: "select_account" | "login"

    String that specifies whether the Authorization Server prompts the End-User for reauthentication or confirm account screen. Supported values: select_account or login. Defaults to select_account.

    redirectUri?: string

    Redirect uri that will receive the code. Must exactly match a redirectUri from your client in self-service

    scope?: "openid" | string & {}

    The OAuth scopes for the tokens. This is a list of scopes, separated by space. If the list of scopes contains openid, the generated tokens includes the id token which can be useful for getting information about the user. Omitting scope is allowed, while invalid_scope is returned when the client asks for a scope you aren't allowed to request. https://tools.ietf.org/html/rfc6749#section-3.3 Defaults to openid.

    state: string

    An opaque value used by the client to maintain state between the request and callback. It's also recommended to prevent CSRF https://tools.ietf.org/html/rfc6749#section-10.12

    tag?: string

    Pulse tag

    teaser?: string

    Teaser slug. Teaser with given slug will be displayed in place of default teaser

    xDomainId?: string

    Identifier for cross-domain tracking in Pulse

    xEnvironmentId?: string

    Environment for cross-domain tracking in Pulse

    Settings

    Member Visibility

    On This Page

    Properties