Django Rest Framework Authentication API

Django Authentication API is a feature-rich authentication system built with Django and Django Rest Framework. It provides user registration, login, password reset, email change, and other authentication-related functionalities.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • API Endpoints
  • Authentication
• Contributing
• License

Getting Started

Prerequisites

Ensure you have the following prerequisites installed:

• Python
• Django
• Django Rest Framework

Installation

1. Clone the repository:

   git clone https://github.com/your-username/django-authentication-api.git

2. Navigate to the project directory:

   cd django-authentication-api

3. Install the required dependencies:

   pip install -r requirements.txt

4. Apply migrations:

   python manage.py migrate

5. Run the development server:

   python manage.py runserver

The API should be accessible at http://localhost:8000/api/accounts/.

Usage

API Endpoints

1. User Account Information: /account/

   • Method: GET
   • Requires authentication

2. User Account Change: /account/change/

   • Method: POST
   • Requires authentication
   • Update user information (first name, last name)

3. User Login: /login/

   • Method: POST
   • Input: Email and password
   • Returns user information

4. User Signup: /signup/

   • Method: POST
   • Input: First name, last name, email, and password
   • Returns success message

5. Account Activation: /activate-account/

   • Method: POST
   • Input: Activation code
   • Activates user account so that users can login

6. User Logout: /logout/

   • Method: POST
   • Requires authentication
   • Logs out the user

7. Password Reset Request: /password-reset/

   • Method: POST
   • Input: Email
   • Sends a verification code for password reset to the user's email

8. Password Reset Verify: /password-reset/verify/

   • Method: POST
   • Input: Verification code and new password
   • Resets the user's password

9. Email Change Request: /email-change/

   • Method: POST
   • Requires authentication
   • Sends a verification code for email change to the user's email

10. Email Change Verify: /email-change/verify/

    • Method: POST
    • Input: Verification code and new email
    • Changes the user's email

11. Password Change: /password-change/

    • Method: POST
    • Requires authentication
    • Input: Old password and new password
    • Changes the user's password

Authentication

• Token Authentication is used to secure endpoints where necessary

Contributing

• Fork the repository.
• Create a new branch for your feature: git checkout -b feature-name.
• Commit your changes: git commit -m 'Add new feature'.
• Push to the branch: git push origin feature-name.
• Submit a pull request.