Django REST Simple Api Key

An API Key authentication plugin for the Django REST Framework.

---

Django REST Simple Api Key is a package built upon Django, Django REST Framework, and the fernet cryptography module to generate, encrypt, and decrypt API keys.

Acknowledgments

This project borrows code from the Django REST Framework as well as concepts from the implementation of another API Key library for the Django REST Framework, djangorestframework-api-key.

Contents

• Getting Started
  • Introduction
    • Benefits
  • Quickstart
  • Generate a Fernet Key
  • Changelog
  • Contributing
• Settings
  • FERNET_SECRET
  • API_KEY_LIFETIME
  • AUTHENTICATION_KEYWORD_HEADER
  • ROTATION_FERNET_SECRET
• Customize the APIKey model
• Permissions
• Authentication
  • Use the APIKeyAuthentication backend
• API Key Rotation
  • Key Rotation Overview
  • Activation
    • Using Django Management Command
    • Using Django Admin Interface
  • How Rotation Works
    • Key Rotation Phases
    • Key Usage During Rotation
• API Key Analytics Middleware
  • API Key Analytics Middleware Usage cases
    • Middleware Overview
    • Setup
    • Activation
    • How the Middleware Works
    • Data Access
• Package Renaming Migration Guide
  • Renaming the Package
  • Updating Project Imports
  • Migrating Django Settings
  • Support and Feedback
• Development and Contributing
  • Pull Request Process
  • Code of Conduct
    • Our Pledge
    • Our Standards
    • Our Responsibilities
    • Scope
    • Attribution
• Changelog
  • [v2.0.1] - 2024-05-23
  • [v2.0.0] - 2024-05-23
  • [v1.1.0] - 2024-05-23
  • [v1.0.2] - 2023-09-16
  • [v0.1.2] - 2023-04-21
  • [v0.1.1] - 2023-02-26
  • [v0.1.0] - 2023-02-06
  • [v0.0.3] - 2023-02-05
  • [v0.0.2] - 2023-02-04
  • [v0.1.2] - 2023-04-21
  • [v0.1.1] - 2023-02-26
  • [v0.1.0] - 2023-02-06
  • [v0.0.3] - 2023-02-05
  • [v0.0.2] - 2023-02-04
  • [v0.1.2] - 2023-04-21
  • [v0.1.1] - 2023-02-26
  • [v0.1.0] - 2023-02-06
  • [v0.0.3] - 2023-02-05
  • [v0.0.2] - 2023-02-04
  • [v0.0.1] - 2023-02-04

Indices and tables

• Index

• Module Index