saml2-sp-nodejs
    Preparing search index...

    Interface LoginOptions

    Per sign-in choices; each defaults to the configuration.

    interface LoginOptions {
        forceAuthn?: boolean;
        isPassive?: boolean;
        nonce?: string;
        relayState?: string;
        requestBinding?: RequestBinding;
        responseBinding?: ResponseBinding;
        subjectHint?: string;
        subjectHintFormat?: string;
    }
    Index
    forceAuthn? isPassive? nonce? relayState? requestBinding? responseBinding? subjectHint? subjectHintFormat?
    forceAuthn?: boolean

    Ask the identity provider to authenticate the person again even if it has a session.

    isPassive?: boolean

    Ask the identity provider not to interact with the person.

    nonce?: string

    For requestBinding: 'post': a CSP nonce for the auto-submit script on the form page.

    relayState?: string

    Opaque state the identity provider returns unchanged (at most 80 bytes, Bindings 3.4.3). Typically where to go after sign-in.

    requestBinding?: RequestBinding
    responseBinding?: ResponseBinding
    subjectHint?: string

    Who the request is for: sent as the AuthnRequest's <saml:Subject><saml:NameID> (Core 3.4.1), a hint like OIDC's login_hint. An identity provider holding several accounts in one browser uses it to pick that account, or pre-fills its sign-in screen with it. It is never proof of who signs in: the Response's assertion says that.

    subjectHintFormat?: string

    The hint's NameID Format, e.g. the one the identity provider issued it in (SamlLogin.nameIdFormat).

    Settings
    Member Visibility

    On This Page
    Properties