API Reference

Zero Trust Access with Cloudflare Access for Flask applications.

class flask_cfaccess.CfAccess(app=None)

Zero Trust Access with Cloudflare Access for Flask applications.

Parameters:

app (Flask | None) – The Flask application instance. The application instance is optional and can be passed by calling cfaccess.init_app(app) in your application factory function.

authenticate(token=None)

Validate that a request is authenticated.

get_identity(token=None)

Get the user’s identity.

init_app(app)

Initialize the application.

Parameters:

app (Flask) – The Flask application.instance.

login_required(f)

Decorate a view to require a valid identity.

validate_identity(identify)

Decorate a view to validate the user’s identity.

flask_cfaccess.get_identity()

Get the user’s identity.

flask_cfaccess.login_required(f)

Decorate a view to require that the request is authenticated.

flask_cfaccess.validate_identity(identify)

Decorate a view to validate the user’s identity.