Global

Members

checkApiAuthentication

express middleware for ensuring either HTTP Bearer or JWT access token

Source:

Methods

configureOAUTH2()

configure oauth2server

Source:

configurePassport()

Add two more strategies to passport for client-basic authentication, this allows you to use HTTP Basic Auth with your client token id and client secret to obtain an authorization code

Source:

get_jwt_token(req, res)

authorization request to obtain a JWT access token (requires, username, password, clientid, entitytype (optional user entitytype))

Parameters:
Name Type Description
req object

express request object

res object

express response object

Source:

get_user_profile(req, res)

basic route to test authenticated request that returns user id, entitytype, username and created dates

Parameters:
Name Type Description
req object

express request object

res object

express response object

Source:

getRandomInt(min, max) → {Number}

Return a random int, used by utils.uid()

Parameters:
Name Type Description
min Number
max Number
Source:
Returns:
Type
Number

isJWTAuthenticated(req, res, next)

looks up valid jwt tokens and sets user variable

Parameters:
Name Type Description
req object

express request object

res object

express response object

next function

express middleware callback function

Source:

limitLoginAttempts(user) → {object}

update user to mark login attempts

Parameters:
Name Type Description
user object

user from db

Source:
Returns:

updated user

Type
object

loginAttemptsError(user, done) → {function}

send error if user is locked out

Parameters:
Name Type Description
user object

user from db

done function

callback function

Source:
Returns:

callback function

Type
function

set_client_data(req, res, next)

sets additional request variables for creating new client applications, so can query the correct user collection in db

Parameters:
Name Type Description
req object

express request object

res object

express response object

next function

express middleware callback function

Source:

uid(len) → {String}

Return a unique identifier with the given len.

utils.uid(10);
// => "FDaS435D2z"
Parameters:
Name Type Description
len Number
Source:
Returns:
Type
String