2.0.4 • Published 8 years ago
hapi-users-plugin v2.0.4
hapi-users-plugin (WIP)
HAPI plugin for users and login.
Install
npm i hapi-users-plugin --saveEndpoints
All endpoints, except /authenticate requires that Authorization is set in headers with valid JWT
POST /api/users/authenticate- Default payload:
username- Joi.string().required()password- Joi.string().required()
- Response if valid login:
- Body:
loggedin- true
- Headers:
authorization- Signed JWT to use
- Body:
- Default payload:
GET/POST /api/users/unauthenticatePUT /api/users- Default payload:
id- Joi.objectId()username- Joi.string()password- Joi.string()admin- Joi.boolean()
- Response if editing own user:
- Headers:
authorization- Updated and signed JWT to use.
- Headers:
- Default payload:
DELETE /api/users- Default payload:
id- Joi.objectId().required()
- Default payload:
POST /api/users- Default payload:
username- Joi.string().required()password- Joi.string().required()admin- Joi.boolean().default(false)
- Default payload:
GET /api/users- Optional parameters:
from- Joi.objectId() - From which userid the list shall begin (omitting fromId)limit- Joi.number() - Total of users to get
- Default response:
- Array with all users, passwordhash omitted
- Optional parameters:
GET /api/users/{username}- Default response:
- Object with user, passwordhash omitted
- Default response: