diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/1.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/1.png new file mode 100644 index 00000000..726cde47 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/1.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/10.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/10.png new file mode 100644 index 00000000..a88d5d8b Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/10.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/2.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/2.png new file mode 100644 index 00000000..7087109c Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/2.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/3.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/3.png new file mode 100644 index 00000000..aae562bf Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/3.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/4.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/4.png new file mode 100644 index 00000000..85d1e24d Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/4.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/5.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/5.png new file mode 100644 index 00000000..ce0d7728 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/5.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/6.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/6.png new file mode 100644 index 00000000..b7b3cd01 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/6.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/7.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/7.png new file mode 100644 index 00000000..b053ded8 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/7.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/8.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/8.png new file mode 100644 index 00000000..3cf0e617 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/8.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/9.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/9.png new file mode 100644 index 00000000..3aff50c3 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/9.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/caret.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/caret.png new file mode 100644 index 00000000..13a132ab Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/caret.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/closeview.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/closeview.png new file mode 100644 index 00000000..d0fbb0e4 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/closeview.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/crane.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/crane.png new file mode 100644 index 00000000..225ecf3f Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/crane.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/facebook.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/facebook.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/greencheckbox.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/heart_icon.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/heart_icon.png new file mode 100644 index 00000000..bff9ea90 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/heart_icon.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/horizonalline.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/linkedin.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/linkedin.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua10.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua10.png new file mode 100644 index 00000000..af433fff Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua10.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua11.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua11.png new file mode 100644 index 00000000..d6545623 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua11.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua12.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua12.png new file mode 100644 index 00000000..65836f2a Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua12.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua13.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua13.png new file mode 100644 index 00000000..a1019824 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua13.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua14.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua14.png new file mode 100644 index 00000000..934ab59b Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua14.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua15.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua15.png new file mode 100644 index 00000000..2bed8079 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua15.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua16.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua16.png new file mode 100644 index 00000000..8414157e Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua16.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua17.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua17.png new file mode 100644 index 00000000..5de39a9c Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua17.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua18.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua18.png new file mode 100644 index 00000000..63314039 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua18.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua19.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua19.png new file mode 100644 index 00000000..95740668 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua19.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua22.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua22.png new file mode 100644 index 00000000..126af59c Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua22.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua23.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua23.png new file mode 100644 index 00000000..0a3c80c1 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua23.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua24.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua24.png new file mode 100644 index 00000000..9a4631c7 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua24.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua7.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua7.png new file mode 100644 index 00000000..635f7500 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua7.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua8.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua8.png new file mode 100644 index 00000000..8a33c821 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua8.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua9.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua9.png new file mode 100644 index 00000000..225380ed Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/pua9.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/sigma_footer.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/twitter.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/twitter.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_1.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_1.png new file mode 100644 index 00000000..541883d4 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_1.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_10.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_10.png new file mode 100644 index 00000000..f67fffa1 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_10.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_11.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_11.png new file mode 100644 index 00000000..43299882 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_11.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_12.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_12.png new file mode 100644 index 00000000..9b898664 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_12.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_13.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_13.png new file mode 100644 index 00000000..f17c3ccb Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_13.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_14.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_14.png new file mode 100644 index 00000000..c1ba9b99 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_14.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_15.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_15.png new file mode 100644 index 00000000..8631b7ad Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_15.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_16.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_16.png new file mode 100644 index 00000000..96cf0a6e Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_16.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_17.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_17.png new file mode 100644 index 00000000..d8ca7523 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_17.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_18.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_18.png new file mode 100644 index 00000000..3050b787 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_18.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_19.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_19.png new file mode 100644 index 00000000..93f4e084 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_19.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_2.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_2.png new file mode 100644 index 00000000..61b11bea Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_2.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_20.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_20.png new file mode 100644 index 00000000..71fdc45e Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_20.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_4.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_4.png new file mode 100644 index 00000000..f6701c86 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_4.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_5.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_5.png new file mode 100644 index 00000000..1579665d Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_5.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_6.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_6.png new file mode 100644 index 00000000..f0fdcef7 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_6.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_7.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_7.png new file mode 100644 index 00000000..e1e4cbb7 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_7.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_8.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_8.png new file mode 100644 index 00000000..983e9579 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_8.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_9.png b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_9.png new file mode 100644 index 00000000..241ae644 Binary files /dev/null and b/site/sigmaguides/src/embedding_03_parameters_ua_v3/assets/uap_9.png differ diff --git a/site/sigmaguides/src/embedding_03_parameters_ua_v3/embedding_03_parameters_ua_v3.md b/site/sigmaguides/src/embedding_03_parameters_ua_v3/embedding_03_parameters_ua_v3.md new file mode 100644 index 00000000..1b1bef48 --- /dev/null +++ b/site/sigmaguides/src/embedding_03_parameters_ua_v3/embedding_03_parameters_ua_v3.md @@ -0,0 +1,458 @@ +author: pballai +id: embedding_03_parameters_ua_v3 +summary: embedding_03_parameters_ua_v3 +categories: Embedding +environments: web +status: published +feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues +tags: embedding +lastUpdated: 2025-05-13 + +# Embedding 03: Parameters and User-Attributes + +## Overview +Duration: 5 + +This QuickStart guide explains how Sigma uses its server-side embed-API ("API") to facilitate embedding Sigma content into external applications. + +Its primary function is to generate a secure, signed JWT (JSON Web Token) that authorizes access to Sigma content at runtime, aligning with the parent application's authentication and security context. + +Beyond authentication, the API controls embedded functionality through optional parameters in the JWT payload—such as account types, teams, or custom user attributes + +For a full reference, see Sigma’s [Embed URL Parameters](https://help.sigmacomputing.com/docs/embed-url-parameters) documentation. + +This QuickStart provides examples and screenshots of required and optional parameters to help developers understand their use. + +Before proceeding, ensure you've completed the [Embedding 01: Getting Started](https://quickstarts.sigmacomputing.com/guide/embedding_01_getting_started_v3/index.html?index=..%2F..embedding#1) QuickStart. It covers JWT in detail, so we won’t repeat that here. + + + +For more information on Sigma's product release strategy, see [Sigma product releases](https://help.sigmacomputing.com/docs/sigma-product-releases) + +If something is not working as you expect, here's how to [contact Sigma support](https://help.sigmacomputing.com/docs/sigma-support) + +### Target Audience +Semi-technical users who will be aiding in the planning or implementation of Sigma with embedding. No SQL or technical data skills are required to complete this QuickStart. It assumes some basic computer skills, such as installing software, using Terminal, navigating folders, and performing copy/paste operations. + +### Prerequisites + + + + + + + + + +![Footer](assets/sigma_footer.png) + +## Required JWT Claims +Duration: 20 + +To securely embed Sigma content, a few claims are mandatory in every JWT. These ensure Sigma can authenticate the request and render the correct content. + +**The required claims are:** + +**1 - sub:**
+The email address of the user logging in. + +**2 - exp:**
+Expiration time, as the number of seconds since the Unix epoch. This cannot exceed 30 days. + +**3 - iat:**
+Issued at time, as the number of seconds since the Unix epoch. + +**4 - jti:**
+A unique ID associated with the session. + + + +**5 - account_type:**
+Account type for the embed user. + +**6 - teams:**
+Teams that the embed user belongs to. Pass multiple teams in this format: +["team1", "team2"] + +### Optional JWT claims: + +**1 - iss:**
+Not used by Sigma, but commonly used by applications for additional verification. + +**2 - oauth_token:**
+The OAuth token used when connecting via OAuth. This token must be encrypted with the embed secret. + +**3 - eval_connection_id:**
+The connection to use instead of the workbook’s default connection. + + + +**4 - first_name:**
+Sets the first name of the current embed user. If set, the name will appear in the folder menu and in email notifications. + +**5 - last_name:**
+Sets the last name of the current embed user. If set, the name will appear in the folder menu and in email notifications. + +**6 - ver:**
+JWT version number. The only accepted values are 1.0 or 1.1. If nothing is provided 1.0 is assumed. + +**7 - aud:**
+Audience claim. Must be `sigmacomputing` when using ver: 1.1, and is ignored with ver: 1.0. + +![Footer](assets/sigma_footer.png) + + +## User Attributes in JWT Claims +Duration: 5 + +Sigma user attributes (UAs) act like variables sent from the parent application at runtime using the embed-API. + +Administrators create a UA in Sigma, and the API uses it (by name) to update its value for a particular user session. + +UA usage is well documented. Links to documentation and QuickStarts are below: + +Some common use-cases for UAs are to set values for: + +1: Enforcing row-level security:
+2: In custom SQL, as a where clause:
+3: Dynamic warehouse role switching:
+ +The specific parameter is: +**1 - user_attributes:**
+User attributes for the embed user. Pass multiple attributes in this format: {"attribute1":"value1","attribute2":"value2"}. + +### An example +Let's consider a use case where we want to pass a UA for the user's sales region and use that to filter a table. + +In Sigma, under `Administration` > `User attributes` we created a new UA called `Store_Region` and set the default value to `East`: + + + + + +Next, we added a column to a table containing `Store Region` and set a formula to display `True` or `False` if the UA matches the `Store Region` value. + +We grouped on the `Region Mix` column just to make it easy to see the result. + +The formula we used was: +```code +Contains(CurrentUserAttributeText("Store_Region"), [Store Region]) +``` + +As a result, all rows with the `East` store region are marked `True`: + + + +By setting a filter on the `Region Mix` column to show only `True` values, only `East` rows remain: + + + +After publishing the sample workbook, we tested passing the custom UA for `Store_Region` using the sample embedding app. + +Set a new value for `Store_Region` in the `.env` file: + + + +After reloading the sample application in the browser, we can see the UA enforcing the `West` region: + + + +If we comment out the UA in `.env` and reload the browser, we see only the `East` region, even though no value was passed: + + + +This happens because we set a default value of `East` when creating the UA in Sigma. + +If we remove the default value from the UA configuration in Sigma, the embed displays `No data`. + +This behavior may or may not be desirable. + +For example, we might choose to show all rows when no value is passed. + +In that case, we can adjust the Sigma formula on the `Region Mix` column to: +```code +IsNotNull(CurrentUserAttributeText("Store_Region")) or Contains(CurrentUserAttributeText("Store_Region"), [Store Region]) +``` + +[IsNotNull](https://help.sigmacomputing.com/docs/isnotnull) determines if the cell has a value; True or False. In our case, all the rows will have a value since none are null in the table. + +We now see a mix of store regions (after ungrouping the table for readability) and the expected ~4.5M rows: + + + + + +![Footer](assets/sigma_footer.png) + + +## Additional URL Query Parameters +Duration: 5 + +The following parameters must be appended to the base URL (embed path) in the embed URL query string: + +**1 - disable_mobile_view:**
+If you set this boolean parameter to yes, workbooks won't automatically resize to the mobile layout. This can be useful when you do not want the content to be reduced to a mobile layout. + +**2 - hide_folder_navigation:**
+If set to true, it hides the folder navigation options in the bottom left. + +By default (false), it looks like this: + + + +When set to true, it looks like this: + + + +Some items in the folder list (for example `Send now`) are controlled in the `Account Type` configuration inside Sigma. + +**3 - hide_menu:**
+If set to `true`, hides the menu in the bottom-left for saved workbooks. + +By default (false), it looks like this: + + + +When set to true, it looks like this: + + + +**4 - hide_tooltip:**
+If set to true, tooltips will no longer display when a user hovers over them. + +This applies to charts (line, bar, area, etc) and map chart marks. + +**5 - lng:**
+Apply an existing translation to an embed. Localization allows workbook editors to translate workbook text to other locales. + +Translations are managed per workbook and are available when viewing embedded workbooks and workbook previews. + +For more information, see [Supported languages and locales](https://help.sigmacomputing.com/docs/manage-workbook-localization#supported-languages-and-locales) + +**6 - menu_position:**
+Changes the position of the toolbar to `top`, `bottom`, or `none`. + +Setting it to `none` removes the toolbar. + +If this value isn't set, it defaults to `bottom`. + +For example, if we set `menu_position` to `top` we see it at the top of the embed: + + + +**7 - responsive_height:**
+Setting this to true allows developers to access the `workbook:pageheight:onchange` JavaScript event. + +This is discussed in detail in the [QuickStart: How to: Responsive iframes with Sigma](https://quickstarts.sigmacomputing.com/guide/embedding_dynamic_iframes/index.html?index=..%2F..index#0) + +**8 - theme:**
+Use any of the default themes (`Light`, `Dark`, or `Surface`), or any custom themes defined in your organization. + +Use the name of the theme as the value. **The value is case-sensitive.** + +Example with the `Dark` theme applied: + + + + + +For more information, see [Create and manage workbook themes](https://help.sigmacomputing.com/docs/create-and-manage-workbook-themes) + +![Footer](assets/sigma_footer.png) + + +## Manual Testing +Duration: 5 min + +The sample project is set up to allow us to test URL query parameters manually. + +There is a dedicated section in the `.env` file for each of these, with default values preset for convenience: + + + +The `embed-api.js` file has been modified to include all the parameters (as of this QuickStart), allowing us to evaluate their behavior. + +To test, we only need to set a new value for the parameter we are targeting in `.env` and save the change. + +Next, set a valid value for theme in `.env`. For example, choose `Dark `as the new theme: + + + + + +Ensure the `BASE_URL` is set in the `# QS: parameters_userattributes` section of the `.env` file. + +Since we completed the first QuickStart in this series, we can reuse the `GETTING_STARTED_BASE_URL` value. + +The `CLIENT_ID` and `SECRET` are also present, so we know those work: + + + +In VSCode, open a new Terminal session inside the `embedding_qs_series` project and run the following command: +```code +npm start +``` + + + +In a browser, open: +```code +http://localhost:3000/ +``` + +Select the `03: Parameters & User Attributes` item from the list and click `Go`: + + + +The URL Parameters section will confirm the `Dark `theme was passed, and the embed will render accordingly: + + + +All images in `section 4, Additional URL Query Parameters`, were generated using this method. + +You can now configure additional tests as needed. + +![Footer](assets/sigma_footer.png) + + +## Legacy Parameters +Duration: 5 + +Some Sigma customers may be using these older parameters which are no longer supported with JWT embeds. These parameters have been replaced by other functionality as the product has evolved and are listed here for reference only. + +### Parameters replaced by account feature permissions + +**1 - hide_schedule:**
+**2 - hide_run_as_recipient:**
+**3 - hide_send:**
+ +In `Administration` > `Account Types`, there are options under the `Sharing/Folders` group that manage permissions for these features: + + + +### Events +These parameters control information being emitted from the iframe: + +**1 - loading_bg:**
+**2 - loading_text:**
+ +Instead, use the `workbook:loaded` event to track when content is ready. + +### Show footer +The following parameter has been replaced by the `menu_position` parameter: + +**1 - show_footer:**
+ +![Footer](assets/sigma_footer.png) + + +## Common Error Messages +Duration: 5 + +The following are potential error messages and description to aide in troubleshooting embeds: + + + +### Parameter-based error messages + +**1: Invalid embed_path:**
+ + + + +**2: Invalid Embed secret:**
+ + + +**3: Invalid embed mode:**
+ + + +**4: Invalid clientID:**
+ + + +**5: Invalid email:**
+ + + +**6: Invalid external_user_team:**
+ +However, if the team is left completely blank, this message will be shown instead:

+ + + +**7: Session length has been exceeded:**

+ +When an invalid session_length is sent (e.g., a value of '25920001', which exceeds the maximum of '2592000'), the embed page will display this message
+ + + + + +**8: Invalid time:**
+For example, if the '/1000' is removed from the formula, the embed page will show this message: + + + +![Footer](assets/sigma_footer.png) + + +## What we've covered +Duration: 5 + +In this QuickStart, we explored how Sigma leverages JWT claims and URL parameters to deliver secure, personalized embedded experiences. + +You learned how Sigma’s server-side embed API generates signed URLs using JWTs, controlling authentication, authorization, and user experience at runtime. + +By now, you should feel comfortable configuring Sigma embeds with the right combination of claims, attributes, and parameters to meet your application’s needs. + +**Additional Resource Links** + +[Blog](https://www.sigmacomputing.com/blog/)
+[Community](https://community.sigmacomputing.com/)
+[Help Center](https://help.sigmacomputing.com/hc/en-us)
+[QuickStarts](https://quickstarts.sigmacomputing.com/)
+ +Be sure to check out all the latest developments at [Sigma's First Friday Feature page!](https://quickstarts.sigmacomputing.com/firstfridayfeatures/) +
+ +[](https://twitter.com/sigmacomputing)  +[](https://www.linkedin.com/company/sigmacomputing)  +[](https://www.facebook.com/sigmacomputing) + +![Footer](assets/sigma_footer.png) + +