tishacian / flask-restful-login

Flask restful services login.

flask-restful-login-example

INSTALLATION

Python 3 is required. There are ways to send requests to server. httpie and curl are simple and useful tools. Their use can be seen below.

git clone https://github.com/melihcolpan/flask-restful-login
cd flask-restful-login
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
python -m main

For requests using httpie: https://httpie.org/doc

Register:

http POST :5000/v1/auth/register username=example_username password=example_password email=[e-mail]

Login:

http POST :5000/v1/auth/login email=[e-mail] password=example_password

Response: Got access token and refresh token!

Logout:

http POST :5000/v1/auth/logout Authorization:"bearer ACCESS_TOKEN" refresh_token=REFRESH_TOKEN

Note: Test user and admin users are created in database initializer class.

User login:

http POST :5000/v1/auth/login email=[e-mail] password=test_password

Admin login:

http POST :5000/v1/auth/login email=[e-mail] password=admin_password

Super admin login:

http POST :5000/v1/auth/login email=[e-mail] password=sa_password

Super admin requiring authentication example handlers

http GET :5000/user_add Authorization:"bearer ACCESS_TOKEN"

http GET :5000/users Authorization:"Bearer ACCESS_TOKEN" usernames==test_username,admin_username emails==[e-mail],[e-mail] start_date==01.01.1993 end_date==01.01.2050

Admin requiring authentication example handlers

http GET :5000/data_admin Authorization:"Bearer ACCESS_TOKEN"

User requiring authentication handler

http GET :5000/data_user Authorization:"Bearer ACCESS_TOKEN"

---

For requests using curl: https://curl.haxx.se/download.html

Register:

curl -H "Content-Type: application/json" --data '{"username":"example_name","password":"example_password", "email":"[e-mail]"}' http://localhost:5000/v1/auth/register

Login:

curl -H "Content-Type: application/json" --data '{"email":"[e-mail]", "password":"example_password"}' http://localhost:5000/v1/auth/login

Response: Got access token and refresh token!

Logout:

curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" --data '{"refresh_token":"REFRESH_TOKEN"}' http://localhost:5000/v1/auth/logout

Note: Test user and admin users are created in database initializer class.

User login:

curl -H "Content-Type: application/json" --data '{"password":"test_password", "email":"[e-mail]"}' http://localhost:5000/v1/auth/login

Admin login:

curl -H "Content-Type: application/json" --data '{"password":"admin_password", "email":"[e-mail]"}' http://localhost:5000/v1/auth/login

Super admin login:

curl -H "Content-Type: application/json" --data '{"password":"sa_password", "email":"[e-mail]"}' http://localhost:5000/v1/auth/login

Test super admin requiring authentication example handlers

curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" http://localhost:5000/user_add

curl -X GET 'localhost:5000/users?usernames=test_username,admin_username&emails=[e-mail],[e-mail]&start_date=01.01.1993&end_date=01.01.2050' -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" 

Test admin requiring authentication example handlers

curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" http://localhost:5000/data_admin

Test user requiring authentication handler

curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" http://localhost:5000/data_user