Identity
Identity is an authentication sdk build for Node.js apps using MongoDB.
Identity's purpose is to make authenticating and authorizing user's in your application as easy as possible. Just install the SDK, initialize it, and call Identity.addUser()
to add a new user to your application. The users are stored in your local database, giving you full control with maximum security.
Install
$ npm install identity-sdk Usage
Table of Contents
- Adding Identity to your application
- Log a user in
- Log a user out
- Create a new user
- Get a new Access Token
- License
Adding Identity to your application
To add and initialize Identity to your application, just pass in your database information.
dbHostname: MongoDB hostname (ex. localhost)
dbPort: MongoDB port (ex. 27017)
dbName: MongoDB database name (ex. Identity)
initAdmin: (optional) if true creates an admin user on init
dbConnectCallback: (optional) function called once connected to the database
const Identity = require('identity-sdk').init(dbHostname, dbPort, dbName, initAdmin, dbConnectCallback);
// or
const Identity = require('identity-sdk');
Identity.init(dbHostname, dbPort, dbName, initAdmin, dbConnectCallback);Log a user in
By default, Identity adds an initial admin user to the database:
const userCredentials = {
username: 'admin',
email: 'admin@example.com', // only a username OR an email is required, not both.
password: 'admin'
};
const {
accessToken, // you would send this to your user (client)
refreshToken, // for subsequent resource requests
user
} = await Identity.loginUser(userCredentials);
// accessToken: String (JWT with user as payload)
// refreshToken: String (JWT with user as payload)
// user: Object (admin user document)Log a user out
await Identity.logoutUser(refreshToken);
// or
const userCredentials = {
username: 'admin',
email: 'admin@example.com', // only a username OR an email is required, not both.
};
await Identity.logoutUserEverywhere(userCredentials);Validate and get user from an Access Token (JWT)
const {
user,
validated
} = Identity.validateAccessToken(accessToken);
// user: Object (user data object), null if invalid jwt
// validated: Boolean (is access token valid)Create a new user
To create a new user, you just need to give Identity a username and password. The username and email field must be unique. All other fields described are optional for your convenience.
const newUserObject = {
username, // (required) (unique) User's username
password, // (required) User's plaintext password, gets hashed for you
email, // (unique) User's email
name, // User's full name
given_name, // User's given name
family_name, // User's family name
nickname, // User's nickname
phone_number, // User's phone number
picture, // URL pointing to the user's profile picture
};
newlyCreatedUserDocument = await Identity.createNewUser(newUserObject);
// newlyCreatedUserDocument: Object (new user document)Get a new Access Token
Access tokens expire, when they do pass in the refresh token to get a new one.
const newAccessToken = await Identity.getNewAccessToken(refreshToken);License
Copyright (c) 2021 Mostapha Rammo <mrammo.ca>
