Search results

Embed report using embed secret key

This section explains how to render the report into the web applications by using Single sign-on(SSO) authentication.

For this, you have to frame the embed URL by using embed secret key. To get embed secret key, please follow below steps:

  1. Go to the settings page and click Embed. Enable the Enable embed authentication under that page. Embed settings page
  2. Click Generate Secret button. Generate secret button
  3. On clicking it, the secret key will be generated. Save the secret key safely, as it will not be able to retrieve or restore this generated secret. Copy secret key
  4. Once the secret key is generated, it can be reset by clicking the Reset Secret button. Reset secret Button

    Resetting this code will break the previously working embedded reports

The embed URL should be in the below format, {report URL}/{embed parameters}&embed_signature={signature}

Example: http://localhost:51778/reporting/en-us/site/site1/reports/5ff24040-cd74-42cf-a168-57f8cb7dafed/Sample%20Reports/Invoice&embed_nonce=3e253410-1a82-4fb3-a337-122a8007dafc& &embed_report_export=true&embed_report_comments=true&embed_timestamp=1583928213&embed_expirationtime=100 &embed_signature=W1oqFY6MvJ2lxCwCwLHWihSd19jPfzr

Please find the details of the parameter in the URL as below,

Parameter Description
report URL URL of the report to be embed.
embed parameters Parameters required to embed the report with SSO.
signature Authorized key for the report to be embed

Parameters to generate the signature in the embed URL

The below values are necessary to form the signature

Parameter Mandatory Description Example


Yes Random string that restricts the URL reconstruction or attacks from the hackers



Yes The email id of the user.


No This value makes you to check the views in the embedded report. true


No This value allows you to perform the actions such as save view, update view and delete views in the embedded report. true


No The export option to various format of the report and widget in embedded report is displayed based on this value. true


No The actions related to comments such as post, edit, delete, reply, watch, unwatch, posting the image and user mention list options can be performed in report based on this value. true


Yes The current time as UNIX time stamp. The embed URL formed is valid for 5 minutes from this embed time stamp.



No Set the duration for the token to be alive. It must be represented in seconds. The default time is 86400 s and the maximum is 604800 s.


Generating the signature for the embed URL


Yes A signature generated using the secret code to authenticate the embed URL.

W1oqFY6MvJ2lxCwCwLHWihSd 19jPfzr

The embed parameter should be formed as in the below format.

embed_nonce=5ff24040-cd74-42cf-a168-57f8cb7dafed& _export=true &embed_report _comments=true& &embed_timestamp=1583935418&embed_expirationtime=100

The above formed embed parameter is signed with the secret code generated in the Bold Reports server using the HMACSHA256 algorithm and the generated signed key will be appended with the embed URL as embed_signature.

You can download the sample from here.