This section explains how to embed the Bold BI application into an iframe for versions above 5.2. This support is only available for the following services.
Please follow the steps below continuously, one by one, to embed the Bold BI application and use it in your own application.
Please refer to JWT settings to configure JWT settings
in the Bold ID application. You will need to configure your external application URL details.
After saving the JWT settings, a Signing Key
will be generated. This key must be used to sign the JSON web tokens from your application.
In your application, implement the code to retrieve the JSON web token
using the signing key
generated above. Refer to the sample JSON web token.
Make a call to the Bold BI JWT callback URL, which includes the site Identifier and the JWT web token generated earlier, in order to automatically sign in to the Bold BI application.
{Bold BI URL}/sso/jwt/callback?jwt={token}&site_identifier={site identifier}
Please implement the Iframe code in your application to load the Bold BI tenant URL where you would like to embed the Bold BI application.
<iframe src='http://{your_domain}/bi/site/{site_identifier}'></iframe>
After completing the above steps, your application is now ready.
When the above configuration is set, you need to configure the JWT SSO
as a default authentication so that Bold BI will automatically redirect to your application whenever it get accessed to auto sign In.
To access the UMS Authentication Settings page, click on the link ‘http://{your_domain}/ums/administration’
. Once on the page, enable Default Authentication and select JWT SSO
from the dropdown menu in the General tab. Finally, Save
the settings.
Afterwards, navigate to the Authentication Settings on the BI site URL provided in the preceding iframe using the link ‘http://{your_domain}/bi/site/{site_identifier}/administration’
. Make sure to enable the Global Default Authentication in the Authentication Control tab, and then Save
the settings.
Once you have embedded the Bold BI application, some links within the application will open in a new tab instead of loading inside the configured iframe above. Therefore, we recommend enabling link navigation behavior to open on the same page by referring to the instructions provided in this documentation.
Once the user Login
the sample external application, you can generate a JSON Web Token for that user in order to use it in the Bold BI application.
The generated user token will then be used in the JWT callback URL {Bold BI URL}/sso/jwt/callback?jwt={token}&site_identifier={site identifier}
to automatically log in to the Bold BI application whenever accessing your embedding page.
If the user is available on the Bold BI tenant site, they will log in; otherwise, the user will be added and logged in.
When the Bold BI site embedded page is accessed, it will be loaded in your application as shown.
Please refer to the document for additional information regarding authentication settings.
Please refer to this Embedding Sample link for a sample external application that can be used to embed Bold BI site.