wsfed-caep-nodejs
    Preparing search index...

    Interface WsFedConfig

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

    {
      "realm": "https://app.example.com/",
      "replyUrl": "https://app.example.com/wsfed",
      "idpMetadata": "https://idp.example.com/FederationMetadata/2007-06/FederationMetadata.xml"
    }
    interface WsFedConfig {
        allowUnsolicited?: boolean;
        certificate?: string;
        clockSkewSeconds?: number;
        idpCa?: string;
        idpEntityId?: string;
        idpMetadata: string;
        privateKey?: string;
        realm: string;
        replyUrl: string;
        requestTokenType?: boolean;
        wantAssertionsEncrypted?: boolean;
    }
    Index
    allowUnsolicited? certificate? clockSkewSeconds? idpCa? idpEntityId? idpMetadata privateKey? realm replyUrl requestTokenType? wantAssertionsEncrypted?
    allowUnsolicited?: boolean

    Accept a sign-in 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. Published in the metadata as the encryption key.

    clockSkewSeconds?: number

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

    idpCa?: string

    PEM certificate(s) to trust for TLS to the identity provider (the metadata URL), 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 federation metadata: an http(s) URL, a file path, or the XML itself.

    privateKey?: string

    The RSA private key encrypted assertions are decrypted with: a PEM file path, or the PEM. Required with wantAssertionsEncrypted.

    realm: string

    This relying party's realm: the wtrealm it sends, the audience its assertions must name, and its metadata's entityID.

    replyUrl: string

    The reply URL (wreply): where the identity provider posts the sign-in response, and sends wsignoutcleanup1.0.

    requestTokenType?: boolean

    Ask for a SAML 2.0 assertion with a wreq RequestSecurityToken naming its TokenType. Default true. Turn it off only for an identity provider that refuses wreq and is configured to issue SAML 2.0 to this realm by itself; the response is checked to hold a SAML 2.0 assertion either way.

    wantAssertionsEncrypted?: boolean

    Refuse an assertion that is not encrypted to this relying party's key. Default false.

    Settings
    Member Visibility

    On This Page
    Properties