JrSchmidtt / api-express-user-auth

User management CRUD API with express.

Api User Auth

• Code developed for academic purposes.
• User management CRUD API with express.

Install and Run

1. Clone the repository : git clone https://github.com/JrSchmidtt/api-express-user-auth
2. Install node.js to run
3. Install Visual Studio Code to edit
4. Install HeidiSQL and import database.sql
5. Open the powershell Terminal in Visual studio and run the command npm install in folder to install the dependencies
6. Run the command node index.js in the folder with the usage examples

Endpoints

GET /user

Returns the list of all registered users only for authenticated administrators.

request:

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'http://localhost:8080/user',
  'headers': {
    'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

response:

[
    {
        "id": 19,
        "name": "Dixie",
        "email": "[e-mail]",
        "role": 0
    },
    {
        "id": 25,
        "name": "admin",
        "email": "[e-mail]",
        "role": 1
    }
]

GET/user/:id

Returns information of a specific account.

request:

var request = require('request');
var options = {
var  request  =  require('request');
var  options  = {
'method': 'GET',
'url': 'http://localhost:8080/user/25',
'headers': {'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN',}
};
request(options, function (error, response) {
if (error) throw  new  Error(error);
console.log(response.body);
});

response:

{
"id":  25,
"email":  "[e-mail]",
"role":  1,
"name":  "admin"
}

POST /user

Create a new user account.

request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'http://localhost:8080/user',
  'headers': {
    'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "email": "[e-mail]",
    "name": "admin",
    "password": "0808",
    "role": "1"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

response:

{
    "status": "200",
    "desc": "User has been created",
    "user": "admin",
    "email": "[e-mail]"
}

POST /login

Create an admin authorized token.

request:

var  request  =  require('request');
var  options  = {
'method': 'POST',
'url': 'http://localhost:8080/login',
'headers': {
'Content-Type': 'application/json'
},
body: JSON.stringify({

"email": "[e-mail]",
"password": "SUPER-SECURE-PASSWORD"})

};
request(options, function (error, response) {
if (error) throw  new  Error(error);
console.log(response.body);
});

response:

{
"token":  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImFkbWluQHNlcnZlci"
}

POST /recoverPassword

Generate a password reset token.

request:

var  request  =  require('request');
var  options  = {
'method': 'POST',
'url': 'http://localhost:8080/recoverPassword',
'headers': {
'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({

"token": "[e-mail]"

})
};
request(options, function (error, response) {
if (error) throw  new  Error(error);
console.log(response.body);
});

response:

{
"status":  "200",
"desc":  "Recover Token has been created",
"token":  "dc907a89-9097-47c1-b951-3f64244ff59a",
}

POST /changePassword

Change an account password.

request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'http://localhost:8080/changePassword',
  'headers': {
    'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "token": "9f97107e-d048-4c10-9c1a-60f09d2ca008",
    "password": "NEW-PASSWORD"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

response:

{
"status":  "200",
"desc":  "Password updated"
}

POST/user/:id

Update account information.

request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'http://localhost:8080/user/25',
  'headers': {
    'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "New Name",
    "email": "[e-mail]",
    "role": "1"
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

response:

{
"status":  "200",
"user":  "25",
"desc":  "has been updated"
}

DELETE/user/:id

Delete the account passed to the backend.

request:

var  request  =  require('request');
var  options  = {
'method': 'DELETE',
'url': 'http://localhost:8080/user/9',
'headers': {
'Authorization': 'Bearer AUTHENTICATED-ADMIN-ACCOUNT-TOKEN'}
};
request(options, function (error, response) {
if (error) throw  new  Error(error);
console.log(response.body);
});

response:

{
"status":  "200",
"user":  "17",
"desc":  "has been deleted"
}

Contributing

1. Fork the repository!
2. Clone your fork: git clone https://github.com/JrSchmidtt/api-express-user-auth
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :D

Author

Api User Auth © JrSchmidt.
Authored and maintained by Schmidt#9639.