Skip to content

Feature Request: API Authentication via API Keys #3

@JoelHer

Description

@JoelHer

Summary:

Add support for authenticating API requests using API keys or a similar mechanism to secure endpoints and control access.

Problem:

Currently, the API does not provide a built-in way to authenticate clients. This makes it difficult to:

  • Restrict access to authorized users only.
  • Track usage per client or application.
  • Prevent abuse or unauthorized access.

Proposed Solution:

  • Implement an API key-based authentication system where:
  • Users can generate one or more API keys from the system.
  • Each API request must include a valid API key (e.g., via Authorization header or query parameter).
  • Requests without a valid key are rejected with a 401 Unauthorized response.
  • Optional: Support scopes/permissions per key to limit access to certain endpoints.
  • Optional: Provide logging and analytics on key usage.

Benefits:

  • Enhanced security for the API.
  • Ability to control and monitor client access.
  • Flexible management of keys for different applications or users.

Additional Notes:

None

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions