Skip to main content

TenantAdminController

The tenant registry, for the platform operator.

Base path/api/admin/tenants
ModuleBilling & Platform
Endpoints13
OpenAPI tagTenant Administration
Sourcebackend/src/main/java/com/motorph/payroll/controller/admin/TenantAdminController.java

Endpoints​

MethodPathRequiresHandler
GET/api/admin/tenantsAny authenticated userlist()
GET/api/admin/tenants/{id}Any authenticated usergetById()
POST/api/admin/tenantsAny authenticated usercreate()
PUT/api/admin/tenants/{id}Any authenticated userupdate()
PATCH/api/admin/tenants/{id}/suspendAny authenticated usersuspend()
PATCH/api/admin/tenants/{id}/reactivateAny authenticated userreactivate()
POST/api/admin/tenants/{id}/repairAny authenticated userrepair()
GET/api/admin/tenants/{id}/entitlementsAny authenticated usergetEntitlements()
GET/api/admin/tenants/{id}/subscription-changesAny authenticated usergetSubscriptionChanges()
PUT/api/admin/tenants/{id}/access-modeAny authenticated usersetAccessMode()
PUT/api/admin/tenants/{id}/managed-planAny authenticated usersetManagedPlan()
PUT/api/admin/tenants/{id}/addons/{module}Any authenticated usergrantAddon()
DELETE/api/admin/tenants/{id}/addons/{module}Any authenticated userrevokeAddon()

Notes​

  • POST /api/admin/tenants — Creates a company and everything it needs to be worked in.
  • POST /api/admin/tenants/{id}/repair — Finishes a tenant whose provisioning did not complete.
  • GET /api/admin/tenants/{id}/entitlements — The organization's resolved module access, as its own people see it.
  • PUT /api/admin/tenants/{id}/access-mode — EARLY_ACCESS (every module, for evaluation) or PLAN_ENTITLEMENTS (plan + add-ons).
  • PUT /api/admin/tenants/{id}/managed-plan — The plan for an organization with no provider subscription; a blank plan clears it.
  • DELETE /api/admin/tenants/{id}/addons/{module} — Revoking keeps the module's data; the module becomes read-only.

Call chain​

10 of 15 reachable repositories shown.

Dependencies​

Constructor-injected by Lombok's @RequiredArgsConstructor: TenantAdminService, TenantProvisioningService, com.motorph.payroll.entitlement.EntitlementService, com.motorph.payroll.entitlement.EntitlementAdminService.

Tables reached​

EntityTableTenant-scoped
CompanyProfilecompany_profileYes
CrmPicklistItemcrm_picklist_itemYes
CrmSettingscrm_settingsYes
DeductionTypededuction_typesYes
DeMinimisBenefitTypede_minimis_benefit_typesYes
DepartmentdepartmentYes
LeaveRequestTypeleave_request_typeYes
LegalDocumentAcceptancelegal_document_acceptanceYes
PayrollSettingspayroll_settingsYes
Permissionpermission—
PhHolidayph_holidaysYes
PositionpositionYes
Rolerole—
Tenanttenant—
Userusers—

Generated page

This page is rebuilt from the source on every docs build by docs-site/scripts/gen-code-wiki.mjs. Editing it has no effect — change the code, or, if what you want to say is prose, write it in docs/.