Managing a multi-tenant reporting environment manually through the UI can become challenging as the number of tenants grows.

Bold Reports provides REST APIs that allow organizations to automate tenant onboarding, content organization, user provisioning, database configuration, and report management workflows.

This article explains how the available APIs can be used with the two common multi-tenant architectures discussed in:

• Multi-Tenant Database Connectivity Using Custom Attributes
  https://support.boldreports.com/kb/article/24854/multi-tenant-database-connectivity-using-custom-attributes

• Multi-Tenant Content Organization in Bold Reports
  https://support.boldreports.com/kb/article/24858/multi-tenant-content-organization-in-bold-reports

• Embedded Multi-Tenant User Management in Bold Reports
  https://support.boldreports.com/kb/article/24863/embedded-multi-tenant-user-management-in-bold-reports

Understanding Multi-Tenant Automation

Option 1: One Site per Tenant

Tenant A
└── Site A

Tenant B
└── Site B

Typical Automation Workflow

New Tenant Created
        │
        ▼
Create Site
        │
        ▼
Configure Site Attributes
        │
        ▼
Publish Reports
        │
        ▼
Tenant Ready

Common APIs Used

• Site Management APIs
• User APIs
• Group APIs
• Attributes APIs
• Report Management APIs

Reference:

https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/

Option 2: Single Site with Categories

Master Site
│
├── Company1
├── Company2
└── Company3

Typical Automation Workflow

New Tenant Created
        │
        ▼
Create Category
        │
        ▼
Create Subcategories
        │
        ▼
Configure Attributes
        │
        ▼
Publish Reports
        │
        ▼
Tenant Ready

Common APIs Used

• Category APIs
• Subcategory APIs
• User APIs
• Group APIs
• Attributes APIs
• Report Management APIs

Reference:

https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/

Database Configuration Automation

Regardless of the content organization model, tenant-specific database connectivity can be automated using the Attributes APIs.

Typical scenarios include:

• Creating tenant attributes.
• Updating database mappings.
• Managing tenant database configuration.
• Automating onboarding workflows.
• Maintaining environment-specific settings.

Example:

DatabaseName = Company1DB

Attributes API Reference

https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/#tag/Attributes

For implementation guidance, refer to:

Multi-Tenant Database Connectivity Using Custom Attributes
https://support.boldreports.com/kb/article/24854/multi-tenant-database-connectivity-using-custom-attributes

User and Group Automation

Common automation scenarios include:

• Creating users.
• Updating users.
• Deleting users.
• Creating groups.
• Managing group memberships.
• Synchronizing users from identity providers.

Reference:

https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/

Report and Content Automation

Common scenarios include:

• Publishing reports.
• Updating reports.
• Organizing reports.
• Moving reports between categories.
• Managing shared report catalogs.

Reference:

https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/

Available REST API Versions

• v1.0
  https://help.boldreports.com/enterprise-reporting/rest-api-reference/v1.0/server-api-reference/

• v2.0
  https://help.boldreports.com/enterprise-reporting/rest-api-reference/v2.0/server-api-reference/

• v3.0
  https://help.boldreports.com/enterprise-reporting/rest-api-reference/v3.0/server-api-reference/

• v4.0
  https://help.boldreports.com/enterprise-reporting/rest-api-reference/v4.0/server-api-reference/

• v5.0
  https://help.boldreports.com/enterprise-reporting/rest-api-reference/v5.0/server-api-reference/

Related Articles

Multi-Tenant Database Connectivity Using Custom Attributes

https://support.boldreports.com/kb/article/24854/multi-tenant-database-connectivity-using-custom-attributes

Multi-Tenant Content Organization in Bold Reports

https://support.boldreports.com/kb/article/24858/multi-tenant-content-organization-in-bold-reports

Embedded Multi-Tenant User Management in Bold Reports

https://support.boldreports.com/kb/article/24863/embedded-multi-tenant-user-management-in-bold-reports

Recommendation

For most SaaS and embedded deployments, we recommend:

• Using REST APIs for tenant onboarding and provisioning.
• Using Custom Attributes for database configuration.
• Using One Site per Tenant when strong tenant isolation is required.
• Using a Single Site with Categories when centralized management is preferred.

By combining REST APIs with a well-designed multi-tenant architecture, organizations can automate onboarding, content organization, database configuration, and report deployment while reducing administrative overhead and improving scalability.