You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/09/04 20:40:26 UTC

(superset) 01/01: docs(security): document PERMISSION_INSTRUCTIONS_LINK templating

This is an automated email from the ASF dual-hosted git repository.

rusackas pushed a commit to branch docs/pr-41843-needs-docs-feat-security-actionable-requ
in repository https://gitbox.apache.org/repos/asf/superset.git

commit ad3b337aba192b85c2e7e35b63d4404f13ff1545
Author: rusackas <ev...@rusackas.com>
AuthorDate: Fri Sep 4 13:40:11 2026 -0700

    docs(security): document PERMISSION_INSTRUCTIONS_LINK templating
    
    #41843 added templated {datasource_id}/{datasource_name}/{table_names}/{username}
    placeholders to PERMISSION_INSTRUCTIONS_LINK so the "Request access" link on
    data-permission errors can deep-link into an org's access-request tool, but the
    security config docs only described roles/permissions in general terms.
    
    Co-Authored-By: Claude <no...@anthropic.com>
---
 docs/admin_docs/security/security.mdx | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/docs/admin_docs/security/security.mdx b/docs/admin_docs/security/security.mdx
index 4b12e7b0e3f..9acaec1d181 100644
--- a/docs/admin_docs/security/security.mdx
+++ b/docs/admin_docs/security/security.mdx
@@ -132,6 +132,31 @@ tables in the **Permissions** dropdown. To select the data sources you want to a
 You can then confirm with users assigned to the **Gamma** role that they see the
 objects (dashboards and slices) associated with the tables you just extended them.
 
+### Actionable Access-Denied Messages
+
+When a viewer opens a chart or dashboard built on a dataset they don't have access to, Superset
+shows a plain-language error naming the dataset (or tables, for SQL Lab) and, when known, the
+chart owners to contact. You can also point users at your own access-request process by setting
+`PERMISSION_INSTRUCTIONS_LINK` in `superset_config.py`:
+
+```python
+PERMISSION_INSTRUCTIONS_LINK = (
+    "https://access.example.com/request?dataset={datasource_name}&user={username}"
+)
+```
+
+The URL may include any of the following placeholders, which are substituted with URL-encoded
+values so the link can deep-link into an internal ticketing or access-request tool with the
+denied resource pre-filled:
+
+- `{datasource_id}` — id of the denied dataset (datasource errors)
+- `{datasource_name}` — name of the denied dataset (datasource errors)
+- `{table_names}` — comma-separated denied table names (table/SQL errors)
+- `{username}` — the requesting user's username
+
+A URL with no placeholders is used as-is, and leaving `PERMISSION_INSTRUCTIONS_LINK` unset (the
+default) omits the "Request access" link, falling back to owner-contact guidance.
+
 ### Subjects
 
 A **subject** is a unified identity that can be granted access to Superset resources such as