helio-mod-users

Helio API Boilerplate: Users Mod

Handles user registration, authentication, profile/setting management, and more.

This mod may be installed into projects utilizing Helio API Boilerplate.

---

• Helio API Boilerplate: Users Mod
  • Install
  • Methods
    • GET /
    • DELETE /
    • POST /register [public]
    • POST /login [public]
    • GET /logout
    • GET /settings
    • GET /settings/:key
    • PUT /settings/:key
    • GET /client-settings
    • PUT /client-settings
    • GET /profile
    • GET /profile/:key
    • PUT /profile/:key
    • GET /username
    • GET /username/availability [public]
    • PATCH /username
    • PATCH /password

---

Install

yarn add helio-mod-users # or npm install helio-mod-users

import UsersMod from 'helio-mod-users'
Mods = [{ path: '/user', module: UsersMod }]

More information on Helio mods

Methods

GET /

• Get user object of current user

DELETE /

• Delete current user

POST /register [public]

{ email: '[e-mail]', password: 'supersecretpassword' }

• Register a new user; returns auth token

POST /login [public]

{ email: '[e-mail]', password: 'supersecretpassword' }

• Login as user; returns auth token

GET /logout

• Invalidate token for current user

GET /settings

• Get settings object of current user

GET /settings/:key

• Get setting value with key name :key

PUT /settings/:key

{ value: 'NewValue' }

• Set value for setting with key name :key

GET /client-settings

• Get client settings object; may be used by a frontend to store preferences

PUT /client-settings

{ any: 'thing', can: 'be', stored: 'here' }

• Update the client settings object; may be used by a frontend to store preferences

GET /profile

• Get profile object of current user

GET /profile/:key

• Get value for profile item with key name :key

PUT /profile/:key

{ value: 'NewValue' }

• Set value for profile item with key name :key

GET /username

• Get username of current user

GET /username/availability [public]

{ username: 'MyNewUsername' }

• Check availbility of username

PATCH /username

{ username: 'MyNewUsername' }

• Change username of current user

PATCH /password

{ currentPassword: 'mycurrentpassword', newPassword: 'mynewpass', confirmPassword: 'mynewpass' }

• Update password for current user