How to Retrieve the Global Embed Secret Key in Bold BI?

In Bold BI, there are different methods to retrieve the Embed Secret Key depending on the version and type of key being used. This article outlines the steps to retrieve the Global Embed Secret Key without causing downtime to existing live embed applications.

Prerequisites

• Ensure you are using Bold BI version v7.10 or later.
• Confirm that your application is utilizing the Global Embed Secret Key.

Steps to Retrieve the Global Embed Secret Key

1. Obtain the Bearer Token:
   To retrieve the Embed Secret Key, you first need to obtain a bearer token. This can be done by sending a POST request with your client ID and client secret.

   Request Details:

   • Method: POST
   • URL: http://{domainname}/api/token
   • Body: Include your client ID and client secret.

   For more information on how to obtain the client ID and client secret, refer to the following article: How to Obtain Client ID and Client Secret for a Site.

2. Retrieve the Embed Secret Key:
   After obtaining the bearer token, you can use it to retrieve the Global Embed Secret Key.

   Request Details:

   • Method: GET
   • URL: http://{domainname}/api/v2.0/administration/embed/configuration
   • Headers: Include the bearer token in the authorization header.

Important Notes

• If your application is using a Tenant-specific Embed Secret Key, it is not possible to retrieve the existing key. In this case, the only option is to regenerate the key, which may disrupt existing live embed applications.

Additional References

• Embed Settings Documentation
• Embed Secret Code Retrieval

For further assistance or queries, please reach out to the support team.