Skip to content

Commit 1990abe

Browse files
author
Max Scholz
committed
restored some information that got lost
1 parent 10ddbf3 commit 1990abe

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

README.MD

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![Build Status](https://travis-ci.org/Staffbase/plugins-sdk-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/plugins-sdk-nodejs) [![Greenkeeper badge](https://badges.greenkeeper.io/Staffbase/plugins-sdk-nodejs.svg)](https://greenkeeper.io/)
12
# Staffbase Plugins SDK for Node.js.
23

34
If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/api/plugin-sso/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.

docs/API.MD

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11

2+
## Classes
3+
Global | Description
4+
------ | -----------
5+
SSOToken | SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
6+
SSOTokenData : SSOTokenData | SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values.
7+
8+
## Functions
9+
Global | Description
10+
------ | -----------
11+
ssoMiddleWare(secret, audience) ⇒ function | Mountable express middleware functions
12+
readKeyFile(path, cb) ⇒ String | Reads public key file from the specified path and returns a string representation
13+
of the key to be used to decode token.
14+
asCert(cert, type) ⇒ string | asCert converts a binary encoded key to PKCS8 format
15+
isPKCS8Format(key, type) ⇒ Boolean | Checks if the format of the key is similar to PKCS8 Format.
16+
transformKeyToFormat(key, type) ⇒ String | Transforms the provided key to PKCS8 format for supported jwt algorithm.
17+
218
## SSOToken
319
SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
420

0 commit comments

Comments
 (0)