Skip to content

Commit

Permalink
docs: update embedded readme with user params context (#25800)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbat authored Jan 17, 2024
1 parent 860aa55 commit 6443001
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions superset-embedded-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ Guest tokens can have Row Level Security rules which filter data for the user ca

The agent making the `POST` request must be authenticated with the `can_grant_guest_token` permission.

Within your app, using the Guest Token will then allow authentication to your Superset instance via creating an Anonymous user object. This guest anonymous user will default to the public role as per this setting `GUEST_ROLE_NAME = "Public"`.
+
+The user parameters in the example below are optional and are provided as a means of passing user attributes that may be accessed in jinja templates inside your charts.

Example `POST /security/guest_token` payload:

```json
Expand Down

0 comments on commit 6443001

Please sign in to comment.