Skip to main content

Open edX AuthZ provides the architecture and foundations of the authorization framework.

Project description

openedx-authz

PyPI CI Codecov Documentation Supported Python versions License status-badge

Purpose

Open edX AuthZ provides the architecture and foundations of the authorization framework. It implements the core machinery needed to support consistent authorization across the Open edX ecosystem.

This repository centralizes the architecture, design decisions, and reference implementation of a unified model for roles and permissions. It introduces custom roles, flexible scopes, and policy-based evaluation, aiming to replace the fragmented legacy system with a scalable, extensible, and reusable solution.

See the Product Requirements document for Roles & Permissions for detailed specifications and requirements.

Change Log

Unreleased

0.13.1 - 2025-11-06

Fixed

  • Avoid duplicates when getting scopes for given user and permissions.

0.13.0 - 2025-11-05

Added

  • Add support for global scopes instead of generic sc scope to support instance-level permissions.

0.12.0 - 2025-10-30

Changed

  • Load authorization policies in permission class.

0.11.2 - 2025-10-30

Added

  • Consider Content Library V2 toggle only in CMS service variant.

0.11.1 - 2025-10-29

Changed

  • Refactor to get permissions’ scopes instead of role.

Fixed

  • Use correct content library toggle to check if Content Library V2 is enabled.

0.11.0 - 2025-10-29

Added

  • Disable auto-save and auto-load of policies if Content Library V2 is disabled.

0.10.1 - 2025-10-28

Fixed

  • Fix constants and test class to be able to use it outside this app.

0.10.0 - 2025-10-28

Added

  • New get_object() method in ScopeData to retrieve underlying domain objects

  • Implementation of get_object() for ContentLibraryData with canonical key validation

Changed

  • Refactor ContentLibraryData.exists() to use get_object() internally

0.9.1 - 2025-10-28

Fixed

  • Fix role user count to accurately filter users assigned to roles within specific scopes instead of across all scopes.

0.9.0 - 2025-10-27

Added

  • Function API to retrieve scopes for a given role and subject.

0.8.0 - 2025-10-24

Added

  • Allow disabling auto-load and auto-save of policies by setting CASBIN_AUTO_LOAD_POLICY_INTERVAL to -1.

Changed

  • Migrate from using pycodestyle and isort to ruff for code quality checks and formatting.

  • Enhance enforcement command with dual operational modes (database and file mode).

0.7.0 - 2025-10-23

Added

  • Initial migration to establish dependency on casbin_adapter for automatic CasbinRule table creation.

0.6.0 - 2025-10-22

Changed

  • Use a SyncedEnforcer with default auto load policy.

Removed

  • Remove Casbin Redis watcher from engine configuration.

0.5.0 - 2025-10-21

Added

  • Default policy for Content Library roles and permissions.

Fixed

  • Add plugin_settings in test settings.

  • Update permissions for RoleListView.

0.4.1 - 2025-10-16

Fixed

  • Load policy before adding policies in the loading script to avoid duplicates.

0.4.0 - 2025-16-10

Changed

  • Initialize enforcer when application is ready to avoid access errors.

0.3.0 - 2025-10-10

Added

  • Implementation of REST API for roles and permissions management.

0.2.0 - 2025-10-10

Added

  • ADRs for key design decisions.

  • Casbin model (CONF) and engine layer for authorization.

  • Implementation of public API for roles and permissions management.

0.1.0 - 2025-08-27

Added

  • Basic repo structure and initial setup.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openedx_authz-0.13.1.tar.gz (74.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openedx_authz-0.13.1-py2.py3-none-any.whl (82.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file openedx_authz-0.13.1.tar.gz.

File metadata

  • Download URL: openedx_authz-0.13.1.tar.gz
  • Upload date:
  • Size: 74.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for openedx_authz-0.13.1.tar.gz
Algorithm Hash digest
SHA256 671710e6b63c06954e4af1626f19897e7838a61223f14ccfc65b9f98ee916213
MD5 549b909d318947aa86e550492af5cf82
BLAKE2b-256 d95cff5c2aa5913343e2cd6d42a1513f72d58f5e4c11ba0b2912b2b7035aeabf

See more details on using hashes here.

File details

Details for the file openedx_authz-0.13.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for openedx_authz-0.13.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dbb43fd3e9f8e629b8bf451ea26b81d97e7efb76e759d7f18c2324298d37463c
MD5 b60d7e3802bd350064ba390351dc5583
BLAKE2b-256 16e0c5de685626b6a132201cdfe24938748613c28cfbe9210c972aecedfd5eca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page