Skip to content

Repository files navigation

node-multipass Build Status

Tender provides a mechanism for single sign-on known as Multipass. Multipass uses an AES encrypted JSON hash and node-multipass provides functions for encoding and decoding these tokens.

More details on Multipass can be found here.

Installation

 npm install multipass

Usage

Multipass is constructed with two arguments: an API key and a site key. These keys can be found within the Tender admin (Accounts & Settings > Extras > Single Sign-On).

varMultipass=require('multipass');// Construct the Multipass encoder / decodervarmultipass=newMultipass('API-KEY','SITE-KEY');// Encode a Multipass tokenvartoken=multipass.encode({email: 'test@example.com',name: 'test',expires: '2011-07-06 23:28:40Z'});// Decode a Multipass tokenvarobj=multipass.decode(token);

encode(obj)

This function encodes the required obj argument. This argument is a JavaScript object and contains the data that you want to pass to Tender. A list of expected keys can be found here.

This function will return a string. If an error occurs, the undefined will be returned.

decode(token)

This function decodes the required token argument. This argument is an encoded Multipass token and a JavaScript object is returned. If decoding is not successful, undefined is returned.

About

Encode and decode Tender Multipass tokens

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages