webiny-api-tenant-manager-catalog

Catalogs Webiny tenant management use case abstractions with import paths and source references.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-tenant-manager-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-tenant-manager-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/tenant-manager
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-tenant-manager-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with Webiny's multi-tenancy API need to locate the correct tenant management abstractions and their exact import paths without searching through the monorepo source tree.

Core Features & Use Cases

  • Abstraction Catalog: Lists 9 tenant management abstractions including CreateTenantUseCase, UpdateTenantUseCase, DisableTenantUseCase, EnableTenantUseCase, GetCurrentTenantUseCase, and GetTenantByIdUseCase.
  • Import References: Provides exact import statements from "webiny/api/tenant-manager" and links to source files in @webiny/tenant-manager for interface verification.
  • Use Case: When building a multi-tenant Webiny application, use this catalog to quickly find GetTenantByIdUseCase, read its source for the exact interface, and inject it into your feature implementation.

Quick Start

Ask the AI to show the tenant management use cases available in the Webiny API and how to import CreateTenantUseCase.

Frequently Asked Questions about webiny-api-tenant-manager-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a tenant programmatically in Webiny?

Use CreateTenantUseCase or CreateAndInstallTenantUseCase imported from "webiny/api/tenant-manager". Read the source file at @webiny/tenant-manager/api/features/CreateTenant/abstractions.ts to get the exact interface before implementing.

What tenant management use cases does the Webiny API provide?

The API provides nine abstractions: CreateTenantUseCase, CreateAndInstallTenantUseCase, UpdateTenantUseCase, DisableTenantUseCase, EnableTenantUseCase, GetCurrentTenantUseCase, GetTenantByIdUseCase, TenantModelExtension, and the TenantExtensions type.

How do I get the current tenant in a Webiny API handler?

Import GetCurrentTenantUseCase from "webiny/api/tenant-manager" and inject it into your handler. Check the source at @webiny/tenant-manager/api/features/GetCurrentTenant/abstractions.ts for the exact interface and types.

Can I extend the Webiny tenant model with custom fields?

Yes, use TenantModelExtension imported from "webiny/api/tenant-manager" to extend the tenant content model with custom fields. The source is located at @webiny/tenant-manager/api/domain/TenantModelExtension.ts.

What patterns should I follow when implementing Webiny tenant use cases?

Follow the webiny-use-case-pattern or webiny-event-handler-pattern skills referenced in the catalog. Always read the abstraction source file first to get exact interfaces and types before writing your implementation.