How to Generate the Common UMS Embed Secret Using REST API
Embed secret code can be used in Javascript-based Embedding and Single Sign-On authentication Iframe-based Embedding.
The Common UMS Embed Secret Key is recommended for use cases where dashboards from multiple Bold BI tenants are to be embedded. This key allows for a unified embedding experience across different tenants. Follow this guide for detailed steps on how to generate the common UMS embed secret code using REST API.
REST API for Obtaining an Access Token
Before making any changes, it is necessary to authenticate with the Bold BI server to obtain an access token. This token must be included in the header of all API requests to ensure they are authorized. Refer to the KB article on How to generate Access Token from User Management Server using Bold BI REST API? to get an access token.
Generate Common UMS Embed Secret Code using REST API
You can generate common UMS embed secret code using REST API by following the details below.
API End Point:
Field | Value |
---|---|
Self-Hosted Server URL | https://{yourdomain}/api/v2.0/administration/embed/secrets/regenerate |
Method | POST |
Content-Type | application/json |
Resetting this common embed code will break previously working embedded dashboards across multiple sites.