Embed content from a tenant organization (Beta)

When you use Sigma Tenants, you can embed content from a tenant organization and sign it with a JSON web token (JWT) using embed credentials from the parent organization.

Requirements

• You must be assigned the Admin account type in the parent organization.
• You must have client credentials in the parent organization with both embed and REST API scopes, or both embed client credentials and API client credentials. See Generate embed client credentials and Generate Sigma API client credentials.

Embed a workbook from a tenant organization

To embed a workbook from a tenant organization, do the following:

1. Retrieve tenant organization details
2. Retrieve details about the content that you want to embed
3. Sign the embed URL

Retrieve tenant organization details

To construct the URL for the embedded content, you must know the organization ID and organization slug for the tenant organization.

In the code that you use to create an embed API, retrieve the organization details for the tenant organization:

1. Call the List tenant organizations (GET /v2/tenants) endpoint.

2. For the relevant tenant organization, identify the following details from the response:

   • tenantOrganizationId
   • tenantOrganizationSlug

Retrieve details about the content that you want to embed

In the code that you use to create an embed API, do the following:

1. Retrieve the ID of the deployment policy used to deploy the workbook from the parent organization to the tenant organization:

   1. Call the List deployment policies (GET /v2/deploymentPolicies) endpoint.
   2. In the response, retrieve the deploymentPolicyId.

2. Retrieve the ID of the deployed workbook from the deployment policy:

   1. Call the List documents for a deployment policy (GET /v2/deploymentPolicies/{deploymentPolicyId}/files) endpoint.
   2. In the response, retrieve the workbookId for the workbook that you want to embed and store it as the parentWorkbookId.

3. Identify the ID of the same workbook in the tenant organization:

   1. Call the Get deployed workbook in tenant organization (GET /v2/tenants/{tenantOrganizationId}/workbooks) endpoint and provide the tenantOrganizationId, parentWorkbookId, and deploymentPolicyId.
   2. In the response, retrieve the workbookUrl for the workbook on the tenant organization.

To embed the workbook in the tenant organization, use the workbookUrl in the response. The workbook URL is formatted as follows:

https://app.sigmacomputing.com/<tenantOrganizationSlug>/workbook/<tenantWorkbookId>

💡

If you want to embed a tagged version of the workbook, a page, or an element, or another supported document type, see the other URL structures in Create an embed API with JSON Web Tokens.

Sign the embed URL

After you construct the relevant URL for the embedded content, sign the URL with a JWT using embed credentials.

You can use credentials from the parent organization or the tenant. Refer to the example script in Create an embed API with JSON web tokens.

You must include a tenant JWT claim that passes the value of the tenantOrganizationId. See tenant in the JWT claims reference.