samlify icon indicating copy to clipboard operation
samlify copied to clipboard

V3 API & Announcements

Open tngan opened this issue 4 years ago • 1 comments

This is the 6th year since the first version is being released. The original purpose is to reduce the difficulties for SAML integration of any Node.js application with a set of easy-to-use helper functions.

We are happy to announce that the specification of v3 API is on its way, in order to provide

  • More verbose error message
  • Reduce the complexity of some internal functions
  • Kickstart examples & articles with some modern frameworks
  • Cleanup the entity construction, no more complicated parameters list
  • Refined field key & value interpolation, no need to create a brand new template for single field override
// entity level will be a descriptor only, delegate the process to core module
serviceProvider.fromMetadata(fileUrl[, options)
serviceProvider.fromParams(params[, options)
  • Parsing and generating SAML document with essential information
// testable functions
core.parseLoginRequest
core.createLoginResponse
core.parseLogoutRequest
core.createLogoutResponse
  • Extensibility for customization (i.e. validators)
  • ... etc

We will try hard to reduce the complexity of migration without breaking the interface function of v2 API.

We are also looking for open source contributors that help developing the next version API and a self-hosted community driven IdP. If you are interested in joining us, please send us message via [email protected].

Related tickets

#455 #464

tngan avatar Sep 20 '21 18:09 tngan

WIP Specification and progress

https://www.craft.do/s/yrWIQbmVtCHARh

tngan avatar Jul 24 '22 18:07 tngan