Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.84 KB

README.md

File metadata and controls

49 lines (40 loc) · 1.84 KB
Raw

School Prototype App

The School Prototype App is a straightforward school management application offering essential authentication and authorization features for users across different roles. As of now, the app facilitates user creation, login, and grants access to authenticated users' information.

Features

  • User Creation: Provides an unprotected endpoint for the system's new user registration.
  • Login: Authenticates users and generates a JWT for authenticated sessions.
  • User Information Access: A protected endpoint delivering information about the authenticated user, based on the supplied JWT token.

Endpoints

Create User

  • URL: /users
  • Method: POST
  • Request Body: 
    {
  "username": "bob",
  "password": "password123"
}

Login

  • URL: /login
  • Method: POST
  • Request Body:
 {
   "username": "bob",
   "password": "password123"
 }

Access User Information

  • URL: /auth/me
  • Method: POST
  • Headers: Authorization: Bearer <token>

Password Security

The application currently employs bcrypt to protect the password in order to prevent brute force attacks and rainbow tables.

Implementing Permissions

Next steps

The app is set to support various user roles, including STUDENT, TEACHER, and ADMIN, each with distinct permissions for nuanced access control based on the user's role:

  • STUDENT: Restricted access tailored to student-related information and functionalities.
  • TEACHER: Authorized to manage educational content and access student data.
  • ADMIN: Granted full system access, encompassing user management and application settings. The development of a comprehensive permissions framework is essential to ensure that users access only those features and information pertinent to their role within the application.