archivebox.api.auth

Module Contents

Classes

HeaderTokenAuth	Allow authenticating by passing X-API-Key=xyz as a request header
BearerTokenAuth	Allow authenticating by passing Bearer=xyz as a request header
QueryParamTokenAuth	Allow authenticating by passing api_key=xyz as a GET/POST query parameter

Functions

get_or_create_api_token
auth_using_token	Given an API token string, check if a corresponding non-expired APIToken exists, and return its user
token_from_request
authenticated_user_from_request
auth_using_password	Given a username and password, check if they are valid and return the corresponding user
_require_superuser

Data

API_AUTH_METHODS

API

archivebox.api.auth.get_or_create_api_token(user: django.contrib.auth.models.User | None)

archivebox.api.auth.auth_using_token(token: str | None, request: django.http.HttpRequest | None = None) → django.contrib.auth.models.User | None

Given an API token string, check if a corresponding non-expired APIToken exists, and return its user

archivebox.api.auth.token_from_request(request: django.http.HttpRequest) → str

archivebox.api.auth.authenticated_user_from_request(request: django.http.HttpRequest) → django.contrib.auth.models.User | None

archivebox.api.auth.auth_using_password(username: str | None, password: str | None, request: django.http.HttpRequest | None = None) → django.contrib.auth.models.User | None

Given a username and password, check if they are valid and return the corresponding user

archivebox.api.auth._require_superuser(user: django.contrib.auth.models.User | None, request: django.http.HttpRequest, auth_method: str) → django.contrib.auth.models.User | None

class archivebox.api.auth.HeaderTokenAuth

Bases: ninja.security.APIKeyHeader

Allow authenticating by passing X-API-Key=xyz as a request header

param_name

‘X-ArchiveBox-API-Key’

authenticate(request: django.http.HttpRequest, key: str | None) → django.contrib.auth.models.User | None

class archivebox.api.auth.BearerTokenAuth

Bases: ninja.security.HttpBearer

Allow authenticating by passing Bearer=xyz as a request header

authenticate(request: django.http.HttpRequest, token: str) → django.contrib.auth.models.User | None

class archivebox.api.auth.QueryParamTokenAuth

Bases: ninja.security.APIKeyQuery

Allow authenticating by passing api_key=xyz as a GET/POST query parameter

param_name

‘api_key’

authenticate(request: django.http.HttpRequest, key: str | None) → django.contrib.auth.models.User | None

archivebox.api.auth.API_AUTH_METHODS

None