AuthenticateWrite

class gafaelfawr.dependencies.auth.AuthenticateWrite(*, allow_cookies=True, require_session=False, require_bearer_token=False, require_scope=None, redirect_if_unauthenticated=False, allow_bootstrap_token=False, auth_type=AuthType.Bearer, ajax_forbidden=False)

Bases: Authenticate

Authenticate a write API.

Should be used as a FastAPI dependency.

Parameters:

  • allow_cookies (bool, default: True)

  • require_session (bool, default: False)

  • require_bearer_token (bool, default: False)

  • require_scope (str | None, default: None)

  • redirect_if_unauthenticated (bool, default: False)

  • allow_bootstrap_token (bool, default: False)

  • auth_type (AuthType, default: <AuthType.Bearer: 'bearer'>)

  • ajax_forbidden (bool, default: False)

Methods Summary

__call__(*[, x_csrf_token])

Call self as a function.

Methods Documentation

async __call__(*, x_csrf_token=None, context)

Call self as a function.

Parameters:
Return type:

TokenData