saml-metadata-parser

1.0.1 • Public • Published

SAML Metadata Parser

Installation

npm install saml-metadata-parser

Usage

Parser

The parser is responsible of converting different kind of inputs into SAMLMetadata objects.

parser.fromFile(filePath)

Parameters: path to a *.xml file

Returns: an instance of SAMLMetadata object

parser.fromString(XMLString)

Parameters: string representation of a *.xml file

Returns: an instance of SAMLMetadata object

parser.fromURL(URL)

Parameters: URL which resolves a metadata.xml (e.g. https://adfs.example.com/FederationMetadata/2007-06/FederationMetadata.xml)

Returns: a Promise, which resolves an instance of SAMLMetadata object

SAMLMetadata

A SAMLMetadata object is responsible for storing all necessary metadata information. In addition, it can transform the metadata into different formats, such as passport-saml

addSPConfiguration()

Parameters: object including service provider configurations

Returns: instance of the SAMLMetadata object

asPassportConfig

Parameters: None (the function is getter)

Returns: SAML configuration in passport-saml format

Contributors

License

The MIT License

Readme

Keywords

Package Sidebar

Install

npm i saml-metadata-parser

Weekly Downloads

22

Version

1.0.1

License

MIT

Unpacked Size

86.6 kB

Total Files

14

Last publish

Collaborators

  • smulis