Variable audienceCheck

Type Declaration

• • (
        assertion: any,
        base: any,
        record: any,
        required: any,
    ):
        | { errorCode: string; ok: boolean; why: string }
        | { errorCode?: undefined; ok: boolean; why: string }

  • Checks an assertion's audience restrictions: every restriction must name this service (ourEntityId() or fedClientId), in every mode.

    Parameters

    • assertion: any

      the assertion element

    • base: any

      the service's base URL

    • record: any

      the federation relationship

    • required: any

      whether an assertion with no audience restriction is refused (SAML 2.0) rather than accepted with a warning

    Returns
        | { errorCode: string; ok: boolean; why: string }
        | { errorCode?: undefined; ok: boolean; why: string }

    { ok, why }, with errorCode on a refusal