Tenant Manager > Manage Tenants
Tenant Management via GraphQL API
Learn how to manage tenants within system via the GraphQL API
WHAT YOU'LL LEARN
- How to create, install, and suspend tenants using the GraphQL API
This guide covers the core tenant management operations available through the GraphQL API.
Prerequisites
- Access to your GraphQL API endpoint
- Valid API token with Tenant Manager permissions
Mutations
All tenant operations are available under the tenantManager field in the root Mutation type:
Create Tenant
Creates a new tenant in the system.
Input
Fields:
id(optional) - Custom tenant ID. If not provided, one will be generated automaticallyname(required) - Display name for the tenantdescription(optional) - Tenant description
Request
Variables
Response
Install Tenant
Installs and provisions a tenant with default settings and configurations.
Input
tenantId(required) - ID of the tenant to install
Request
Variables
Response
Disable Tenant
Disables a tenant, preventing access to its resources.
Input
tenantId(required) - ID of the tenant to disable
Request
Variables
Response
Enable Tenant
Re-enables a previously disabled tenant.
Input
tenantId(required) - ID of the tenant to enable
Request
Variables
Response
Error Handling
All mutations return a BooleanResponse type with the following structure:
When an operation fails, check the error field for details:
Complete Example
Here’s a complete workflow for creating and setting up a new tenant: