Skip to content

Commit

Permalink
Update embedding.md (#5912)
Browse files Browse the repository at this point in the history
* Update embedding.md

Adding a final tab on parameter to let customer know they can pass other attributes

* Update embedding.md
  • Loading branch information
royendo authored Oct 16, 2024
1 parent 6fa8584 commit 38f2bbb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/integrate/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ The API accepts the following parameters:
| theme | If [themes](/build/dashboards/customize.md#changing-themes--colors) are being used, the specific theme to pass to the embedded dashboard | No (set to the name of the theme) |
| user_id | The id of the user to embed the dashboard for | No (only one of `user_id`, `user_email`, or `attributes` should be passed in) |
| user_email | The email of the user to embed the dashboard for | No (only one of `user_id`, `user_email`, or `attributes` should be passed in) |
| attributes | Json payload to be put in the access token, used to pass attributes to the dashboard for enforcing policies. When using this make sure to pass all the attributes used in your security policy like `email`, `domain` and `admin` | No (only one of `user_id`, `user_email`, or `attributes` should be passed in) |
| attributes | Json payload to be put in the access token, used to pass attributes to the dashboard for enforcing policies. When using this make sure to pass all the attributes used in your security policy like `email`, `domain` and `admin` and any other custom attributes such as `tenantId`, `customerId`, etc. | No (It is also possible to add custom attributes here) |
| ttl_seconds | The time to live for the iframe URL | No (Default: 86400) |

:::tip Embedding the project vs embedding an individual dashboard
Expand Down Expand Up @@ -379,4 +379,4 @@ export default function RillDashboard() {

### Next.js Example

You can find a different end-to-end example of embedding a Rill dashboard in a **Next.js** project in this sample [Github repo](https://github.com/rilldata/rill-embedding-example).
You can find a different end-to-end example of embedding a Rill dashboard in a **Next.js** project in this sample [Github repo](https://github.com/rilldata/rill-embedding-example).

0 comments on commit 38f2bbb

Please sign in to comment.