oidc-caep-risc-nodejs
    Preparing search index...

    Interface OidcConfigFile

    A configuration file, or the object resolveConfig accepts. Names follow oidc-caep-client where they overlap.

    interface OidcConfigFile {
        acrValues?: string | string[];
        allowInsecure?: boolean;
        client_id?: string;
        clientId?: string;
        clientSecret?: string;
        clockToleranceSec?: number;
        dpop?: "auto" | "always" | "never";
        dpopKey?: string;
        idTokenSignedResponseAlg?: string;
        idTokenSigningAlgs?: string[];
        issuer?: string;
        maxIdTokenAgeSec?: number;
        metadataFile?: string;
        metadataUrl?: string;
        par?: "auto" | "always" | "never";
        post_logout_redirect_uri?: string;
        postLogoutRedirectUri?: string;
        privateKey?: string;
        privateKeyAlg?: string;
        redirect_uri?: string;
        redirectUri?: string;
        requireIdTokenTypAndAtHash?: boolean;
        scopes?: string | string[];
        signals?: boolean;
        ssf?: { pollIntervalMs?: number; transmitter?: string };
        tlsCa?: string;
        tokenEndpointAuthMethod?: string;
    }
    Index
    acrValues?: string | string[]

    acr_values for every authorization request: a space-separated string or an array. The ID token's acr must be one of them.

    allowInsecure?: boolean

    Allow an http issuer and endpoints. Redirect URIs are https, or http on a loopback host, either way. Default false.

    client_id?: string

    oidc-caep-client's name for the same field.

    clientId?: string
    clientSecret?: string

    The client secret, a file: path next to the configuration, or env:VARIABLE. Required for client_secret_basic and client_secret_post.

    clockToleranceSec?: number

    Seconds of clock skew allowed on exp, iat and auth_time. Default 30.

    dpop?: "auto" | "always" | "never"

    DPoP (RFC 9449). Default auto: used when the provider advertises ES256 in dpop_signing_alg_values_supported. always fails at creation when it does not. never sends no proofs.

    dpopKey?: string

    The DPoP private key: a P-256 PEM, a path, file: or env:. Default: a key generated when the relying party is created, held in memory only. Name one when several processes share sign-ins.

    idTokenSignedResponseAlg?: string

    The one ID token alg to accept. When set, it replaces idTokenSigningAlgs. It must be advertised.

    idTokenSigningAlgs?: string[]

    The ID token algorithms to accept. Default ["RS256"]. Each must also be advertised by the provider; none is refused. An HMAC algorithm is accepted only when it is named here (or pinned).

    issuer?: string

    Issuer. With metadataUrl, it must be the issuer that URL was built from.

    maxIdTokenAgeSec?: number

    The oldest ID token iat accepted, in seconds. Default 600.

    metadataFile?: string

    A metadata document on disk, used instead of fetching metadataUrl.

    metadataUrl?: string

    https://idp.example/.well-known/openid-configuration, the name oidc-caep-client uses.

    par?: "auto" | "always" | "never"

    Pushed Authorization Requests. Default auto: used when the provider advertises them, and always when it sets require_pushed_authorization_requests (then never fails at creation).

    Optionalpost_logout_redirect_uri

    post_logout_redirect_uri?: string
    postLogoutRedirectUri?: string
    privateKey?: string

    PEM PKCS#8 private key, a path, file: or env:. Required for private_key_jwt.

    privateKeyAlg?: string

    Algorithm the private key signs the client assertion with. Default RS256.

    redirect_uri?: string
    redirectUri?: string
    requireIdTokenTypAndAtHash?: boolean

    Default true: the ID token header must carry typ (JWT or application/jwt), and when the token response carries an access token, the ID token must carry a matching at_hash. false checks each only when it is present, for a provider that omits them.

    scopes?: string | string[]

    A space-separated string, as in oidc-caep-client's oidc.json, or an array.

    signals?: boolean

    CAEP and RISC. Omitted or true keeps them on. false does not resolve ssf, does not contact a transmitter, and drops ssf.read and ssf.manage from the scopes.

    ssf?: { pollIntervalMs?: number; transmitter?: string }
    tlsCa?: string

    CA trust chain for the provider's TLS listener certificate, in addition to node's own store. PEM, file:path, env:NAME, or a path. A missing file is ignored. iya-sts publishes this bundle at GET /tls/server-certificate (leaf, intermediates, and the root).

    tokenEndpointAuthMethod?: string