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:
Generate Secret
button.
Once the secret key is generated, it can be reset by clicking the 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: |
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 |
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. |
|
|
Yes | A signature generated using the secret code to authenticate the embed URL. |
|
The embed parameter should be formed as in the below format.
|
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.