Skip to content

Update rls patch instructions #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saraburns1 merged 4 commits into from
Feb 18, 2026
Merged

Update rls patch instructions #337

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4fc9778
docs: Update rls patch instructions
saraburns1 Feb 18, 2026
c39d85a
docs: rst typo
saraburns1 Feb 18, 2026
6e6d7a3
docs: rst typo
saraburns1 Feb 18, 2026
4bf9e01
docs: rst typo
saraburns1 Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 32 additions & 14 deletions docs/technical_documentation/how-tos/superset_row_level_security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,37 @@ Superset extra row level security
*********************************

To apply custom row level security filters to Superset, you can use the patch
`superset-row-level-security`. This patch expects a list of python dictionaries
with the following structure:

.. code-block:: yaml

superset-row-level-security: |
{
"schema": "{{ASPECTS_XAPI_DATABASE}}",
"table_name": "{{ASPECTS_XAPI_TABLE}}",
"role_name": "{{SUPERSET_ROLES_MAPPING.instructor}}",
"group_key": "{{SUPERSET_ROW_LEVEL_SECURITY_XAPI_GROUP_KEY}}",
"clause": {% raw %}'{{can_view_courses(current_username(), "splitByChar(\'/\', course_id)[-1]")}}',{% endraw %}
"filter_type": "Regular",
},
``superset-row-level-security``. This patch can overwrite the `default list <https://github.com/openedx/tutor-contrib-aspects/blob/main/tutoraspects/templates/aspects/apps/superset/pythonpath/openedx/create_row_level_security.py#L18-L46>`_ of roles
or use ``append`` to add additional dictionaries.

Overwrite existing:

.. code-block::

SECURITY_FILTERS = [
{
"schema": "{{ASPECTS_XAPI_DATABASE}}",
"table_name": "{{ASPECTS_XAPI_TABLE}}",
"role_name": "{{SUPERSET_ROLES_MAPPING.instructor}}",
"group_key": "{{SUPERSET_ROW_LEVEL_SECURITY_XAPI_GROUP_KEY}}",
"clause": {% raw %}'{{can_view_courses(current_username(), "splitByChar(\'/\', course_id)[-1]")}}',{% endraw %}
"filter_type": "Regular",
},
]

Add to existing:

.. code-block::

SECURITY_FILTERS.append(
{
"schema": "{{ASPECTS_XAPI_DATABASE}}",
"table_name": "{{ASPECTS_XAPI_TABLE}}",
"role_name": "{{SUPERSET_ROLES_MAPPING.instructor}}",
"group_key": "{{SUPERSET_ROW_LEVEL_SECURITY_XAPI_GROUP_KEY}}",
"clause": {% raw %}'{{can_view_courses(current_username(), "splitByChar(\'/\', course_id)[-1]")}}',{% endraw %}
"filter_type": "Regular",
},
)

You can find more information about Superset RLSF in the `Superset documentation <https://superset.apache.org/docs/security/#row-level-security>`_.