iya-sts
    Preparing search index...

    Variable consume

    consume: (
        identifier: any,
        xml: any,
        how: any,
        actor?: any,
        family?: any,
    ) => Record<string, any> = ...

    Type Declaration

      • (
            identifier: any,
            xml: any,
            how: any,
            actor?: any,
            family?: any,
        ): Record<string, any>
      • Consumes a metadata document onto an application's entry: its endpoints become registered return addresses, its signing certificates what its requests are verified against, and its flags and formats are written.

        A signed document is verified where there is an anchor; a document for another entityID, an expired one, or one whose encryption certificate cannot be used is refused.

        Parameters

        • identifier: any

          the application's identifier

        • xml: any

          the document

        • how: any

          how it arrived, for the record

        • Optionalactor: any

          who asked

        • Optionalfamily: any

          the SAML family selected for this import, when supplied

        Returns Record<string, any>

        ok with what was written, or a refusal carrying its error code