GET

/accounts/{AwsAccountId}/session-embed-url

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/session-embed-url

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> API operation. Use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: <ul> <li> <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a> </li> <li> <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> </li> </ul>

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Query Params

entry-pointstring

The URL you use to access the embedded session. The entry point URL is constrained to the following paths: <ul> <li> <code>/start</code> </li> <li> <code>/start/analyses</code> </li> <li> <code>/start/dashboards</code> </li> <li> <code>/start/favorites</code> </li> <li> <code>/dashboards/DashboardId </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard </li> <li> <code>/analyses/AnalysisId </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis </li> </ul>

session-lifetimeinteger

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

user-arnstring

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following: <ol> <li> Active Directory (AD) users or group members </li> <li> Invited nonfederated users </li> <li> IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation </li> </ol> Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/session-embed-url' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET