Embedding the full functionality of the Amazon QuickSight console for registered users
Important
Amazon QuickSight has new API operations for embedding analytics:
GenerateEmbedUrlForAnonymousUser
and
GenerateEmbedUrlForRegisteredUser
.
You can still use the GetDashboardEmbedUrl
and
GetSessionEmbedUrl
API operations to embed dashboards and the
QuickSight console, but they don't contain the latest embedding capabilities. For
more information about embedding using the old API operations, see Embedding analytics using the GetDashboardEmbedURL and GetSessionEmbedURL API operations.
Applies to: Enterprise Edition |
Intended audience: Amazon QuickSight developers |
With Enterprise edition, in addition to providing read-only dashboards you can also provide the Amazon QuickSight console experience in a custom-branded authoring portal. Using this approach, you allow your users to create data sources, datasets, and analyses. In the same interface, they can create, publish, and view dashboards. If you want to restrict some of those permissions, you can also do that.
Users who access QuickSight through an embedded console need to belong to the author or admin security cohort. Readers don't have enough access to use the QuickSight console for authoring, regardless of whether it's embedded or part of the AWS Management Console. However, authors and admins can still access embedded dashboards. If you want to restrict permissions to some of the authoring features, you can add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections:
-
For information about creating custom roles by defining custom console permissions, see Customizing Access to the QuickSight Console.
-
For information about using namespaces to isolate multitenancy users, groups, and QuickSight assets, see QuickSight Namespaces.
-
For information about adding your own branding to an embedded QuickSight console, see Using Themes in QuickSight and the QuickSight Theme API Operations.
In the following sections, you can find detailed information about how to set up embedded Amazon QuickSight dashboards for registered users.