1.0.21 • Published 2 years ago

@incodelang/accounts v1.0.21

Weekly downloads
-
License
GPL-3.0-only
Repository
github
Last release
2 years ago

@incodelang/accounts

A simple account management server for your node.js application.

Installation

Install @incodelang/accounts with npm

  npm install @incodelang/accounts

Install @incodelang/accounts with yarn

  yarn add @incodelang/accounts

Usage/Examples

Integrate in your own express.js application

const { accountServer } = require('@incodelang/accounts')
const express = require('express')

const app = express();

app.listen(3000, "0.0.0.0");

accountServer({
    app: app
})

Standalone express.js application

const { accountServer, sampleApp } = require('@incodelang/accounts')

accountServer({
    app: sampleApp(
        3000, // port [default] = 3000
        "0.0.0.0" // host [default] = "0.0.0.0"
    )
})

API Reference

The parameters must be send in the request body as JSON format.

User API

ResponseDescription
{"error": false, "message": "response message, e.g. data"}The request was successful
{"error": true, "message": "errror message"}The request failed

Create a user

  POST /api/v1/user/users/create
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user

Delete a user

  POST /api/v1/user/users/delete
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user

Login

  POST /api/v1/user/users/login
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user (or a token)

Check if a User exists

  POST /api/v1/user/users/exists
ParameterTypeDescription
usernamestringThe name of the user

Update Username

  POST /api/v1/user/users/update/username
ParameterTypeDescription
oldstringThe current name of the user
usernamestringThe new name of the user
passwordstringThe password of the user

Update Password

  POST /api/v1/user/users/update/password
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe new password of the user
oldstringThe current password of the user

User Data API

Store Data

  POST /api/v1/user/users/data/store
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
datastringThe actual data
dataNamestringThe name of the data

Delete Data

  POST /api/v1/user/users/data/delete
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
dataNamestringThe name of the data

Get Data

  POST /api/v1/user/users/data
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
dataNamestringThe name of the data

Get All Data

  POST /api/v1/user/users/data/delete
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user

Global Data API

Set Data

  POST /api/v1/user/data/set
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
valuestringThe actual data
keystringThe name of the data

Delete Data

  POST /api/v1/user/data/delete
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
keystringThe name of the data

Grant Access

  POST /api/v1/user/data/allow
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
keystringThe name of the data
newUserstringThe name of the new user

Revoke Access

  POST /api/v1/user/data/disallow
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
keystringThe name of the data
newUserstringThe name of the new user

Get Public Data

  POST /api/v1/user/data/get
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
keystringThe name of the data

Postboxes API

Create a Postbox

  POST /api/v1/user/postboxes/create
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
namestringThe name of the postbox

Delete a Postbox

  POST /api/v1/user/postboxes/delete
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
namestringThe name of the postbox

Add Data to a Postbox

  POST /api/v1/user/postboxes/add
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
namestringThe name of the postbox
ownerstringThe owner of the postbox
entrystring or objectThe data you want to add

Clear a Postbox

  POST /api/v1/user/postboxes/clear
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
namestringThe name of the postbox

Read a Postbox

  POST /api/v1/user/postboxes/read
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user
namestringThe name of the postbox

Check if a Postbox exists

  POST /api/v1/user/postboxes/exists
ParameterTypeDescription
ownerstringThe owner of the postbox
namestringThe name of the postbox

Tokens

Create a Token

  POST /api/v1/user/tokens/create
ParameterTypeDescription
usernamestringThe name of the user
passwordstringThe password of the user

Authors

License

GPL-3.0

1.0.19

2 years ago

1.0.21

2 years ago

1.0.20

2 years ago

1.0.18

2 years ago

1.0.17

3 years ago

1.0.16

3 years ago

1.0.15

3 years ago

1.0.14

3 years ago

1.0.13

3 years ago

1.0.12

3 years ago

1.0.11

3 years ago

1.0.10

3 years ago

1.0.9

3 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago