saml2-sp-nodejs
    Preparing search index...

    Interface SamlConfig

    The configuration, as a JSON file holds it. File paths are relative to the file.

    {
      "entityId": "https://app.example.com/saml/metadata",
      "acsUrl": "https://app.example.com/saml/acs",
      "privateKey": "keys/sp.key",
      "certificate": "keys/sp.crt",
      "idpMetadata": "https://idp.example.com/saml2/metadata"
    }
    interface SamlConfig {
        acsUrl: string;
        allowUnsolicited?: boolean;
        certificate: string;
        clockSkewSeconds?: number;
        entityId: string;
        idpCa?: string;
        idpEntityId?: string;
        idpMetadata: string;
        nameIdFormat?: string;
        privateKey: string;
        requestBinding?: RequestBinding;
        responseBinding?: ResponseBinding;
        signals?: boolean;
        wantAssertionsEncrypted?: boolean;
        wantAssertionsSigned?: boolean;
    }
    Index
    acsUrl allowUnsolicited? certificate clockSkewSeconds? entityId idpCa? idpEntityId? idpMetadata nameIdFormat? privateKey requestBinding? responseBinding? signals? wantAssertionsEncrypted? wantAssertionsSigned?
    acsUrl: string

    The assertion consumer service: where the identity provider sends the browser back.

    allowUnsolicited?: boolean

    Accept a Response nobody asked for (identity-provider-initiated sign-in). Default false.

    certificate: string

    The certificate for that key: a PEM file path, or the PEM.

    clockSkewSeconds?: number

    How far the two clocks may disagree, in seconds. Default 60.

    entityId: string

    This service provider's entityID. Its metadata URL is the usual choice.

    idpCa?: string

    PEM certificate(s) to trust for TLS to the identity provider (metadata URL, artifact resolution), beyond node's own store: a file path or the PEM.

    idpEntityId?: string

    For metadata that is an aggregate: the identity provider's entityID.

    idpMetadata: string

    The identity provider's metadata: an http(s) URL, a file path, or the XML itself.

    nameIdFormat?: string

    The NameIDPolicy Format to ask for. Default: none, the identity provider decides.

    privateKey: string

    The RSA private key every request is signed with (and encrypted assertions decrypted with): a PEM file path, or the PEM.

    requestBinding?: RequestBinding

    The binding the AuthnRequest is sent on. Default redirect.

    responseBinding?: ResponseBinding

    The binding the identity provider is asked to send the Response on. Default post.

    signals?: boolean

    Receive CAEP and RISC. Default true. false tells the application not to start a receiver and not to contact a transmitter. SAML sign-in does not use it. This service provider does not start a receiver.

    wantAssertionsEncrypted?: boolean

    Refuse a Response whose assertion is not encrypted (an EncryptedAssertion) to this service provider's key. Default false.

    wantAssertionsSigned?: boolean

    Refuse a Response whose assertion is not signed itself, even when the Response is. Default true.

    Settings
    Member Visibility

    On This Page
    Properties