saasplatform-sdk 1.0.0

SaaS Platform API

saasplatform-sdk

Complete API documentation for the Multi-Tenant SaaS Platform. All protected endpoints require a Bearer JWT token obtained from POST /api/v1/auth/login.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.1.1
• Package version: 1.0.0
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import saasplatform_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import saasplatform_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import saasplatform_sdk
from saasplatform_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saasplatform_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWT-auth
configuration = saasplatform_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with saasplatform_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saasplatform_sdk.AdminApi(api_client)

    try:
        # Get Platform Metrics
        api_instance.admin_controller_get_admin()
    except ApiException as e:
        print("Exception when calling AdminApi->admin_controller_get_admin: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	admin_controller_get_admin	GET /api/v1/admin	Get Platform Metrics
AuditApi	audit_controller_get_logs	GET /api/v1/audit/logs	Get Audit Logs
AuthApi	auth_controller_enable_mfa	POST /api/v1/auth/mfa/enable	Enable MFA
AuthApi	auth_controller_forgot_password	POST /api/v1/auth/forgot-password	Forgot Password
AuthApi	auth_controller_generate_mfa_secret	POST /api/v1/auth/mfa/generate	Generate MFA Secret
AuthApi	auth_controller_google_callback	GET /api/v1/auth/google/callback	Google OAuth Callback
AuthApi	auth_controller_google_login	GET /api/v1/auth/google	Google OAuth
AuthApi	auth_controller_initiate_registration	POST /api/v1/auth/register/initiate	Initiate Registration
AuthApi	auth_controller_list_sessions	GET /api/v1/auth/sessions	List active sessions for the current user
AuthApi	auth_controller_login	POST /api/v1/auth/login	Login
AuthApi	auth_controller_logout	POST /api/v1/auth/logout	Logout
AuthApi	auth_controller_logout_all	POST /api/v1/auth/logout-all	Logout All Devices
AuthApi	auth_controller_refresh	POST /api/v1/auth/refresh	Refresh Token
AuthApi	auth_controller_register	POST /api/v1/auth/register	Register
AuthApi	auth_controller_resend_login_otp	POST /api/v1/auth/resend-login-otp	Resend Login Email OTP
AuthApi	auth_controller_resend_registration_otp	POST /api/v1/auth/register/resend-otp	Resend Registration OTP
AuthApi	auth_controller_resend_verification	POST /api/v1/auth/resend-verification	Resend Verification
AuthApi	auth_controller_reset_password	POST /api/v1/auth/reset-password	Reset Password
AuthApi	auth_controller_revoke_session	DELETE /api/v1/auth/sessions/{id}	Revoke a specific session
AuthApi	auth_controller_switch_workspace	POST /api/v1/auth/switch-workspace	Switch Workspace
AuthApi	auth_controller_verify_email	POST /api/v1/auth/verify-email	Verify Email
AuthApi	auth_controller_verify_login_otp	POST /api/v1/auth/verify-login-otp	Verify Login Email OTP
AuthApi	auth_controller_verify_mfa	POST /api/v1/auth/verify-mfa	Verify MFA (Temp Token)
AuthApi	auth_controller_verify_mfa_challenge	POST /api/v1/auth/mfa/verify-login	Verify MFA Login
AuthApi	auth_controller_verify_mfa_recovery	POST /api/v1/auth/mfa/verify-recovery	Recover MFA
AuthApi	auth_controller_verify_registration_otp	POST /api/v1/auth/register/verify	Verify Registration OTP
AuthorizationApi	authorization_controller_get_access_context	GET /api/v1/authorization/access-context	Resolved RBAC + plan permissions for current workspace
AutomationApi	automation_controller_change_plan	POST /api/v1/internal/automation/change-plan	Internal Plan Override
AutomationApi	automation_controller_ping	POST /api/v1/internal/automation/ping	Automation health ping (internal)
AutomationApi	automation_controller_retry_webhook	POST /api/v1/internal/automation/retry-webhook	Retry Failed Webhook
AutomationApi	automation_controller_send_email	POST /api/v1/internal/automation/send-email	Send Transactional Email
AutomationApi	automation_controller_suspend_tenant	POST /api/v1/internal/automation/suspend-tenant	Suspend Tenant
BillingApi	billing_controller_billing_paddle_webhook	POST /api/v1/billing/webhook/paddle	Paddle webhook receiver
BillingApi	billing_controller_cancel_subscription	DELETE /api/v1/billing/subscription	Cancel Subscription
BillingApi	billing_controller_cancel_trial	DELETE /api/v1/billing/trial	Cancel Free Trial
BillingApi	billing_controller_change_plan	POST /api/v1/billing/change-plan	Change Plan
BillingApi	billing_controller_create_checkout	POST /api/v1/billing/checkout	Create Checkout Session
BillingApi	billing_controller_get_all_usage	GET /api/v1/billing/usage-stats/all	Get Usage Stats
BillingApi	billing_controller_get_entitlements	GET /api/v1/billing/entitlements	Get plan entitlements, limits, and live usage for current tenant
BillingApi	billing_controller_get_file_upload_usage	GET /api/v1/billing/usage/file_upload_bytes	Get File Upload Usage
BillingApi	billing_controller_get_plan_comparison	GET /api/v1/billing/plans	Get plan comparison highlights
BillingApi	billing_controller_get_portal	GET /api/v1/billing/portal	Get Customer Portal
BillingApi	billing_controller_get_subscription	GET /api/v1/billing/subscription	Get Subscription
BillingApi	billing_controller_get_transactions	GET /api/v1/billing/transactions	Get Transaction History
ContactApi	contact_controller_submit	POST /api/v1/contact	Submit marketing contact form
CspReportApi	csp_report_controller_report_violation	POST /api/v1/csp-report
DashboardApi	dashboard_controller_get_metrics	GET /api/v1/dashboard/metrics	Get System Metrics
DevToolsApi	dev_tools_controller_check_dev_mode	GET /api/v1/dev-tools/health
DevToolsApi	dev_tools_controller_trigger_audit	POST /api/v1/dev-tools/trigger-audit
EntitlementApi	entitlement_controller_get_status	GET /api/v1/entitlement/status	Entitlement drift status for current identity / workspace
EntitlementApi	entitlement_controller_reactivate	POST /api/v1/entitlement/reactivate/{tenantId}	Reactivate an archived workspace (paid or within quota)
EntitlementApi	entitlement_controller_select_primary	POST /api/v1/entitlement/select-primary	Choose primary workspace; other owned workspaces are archived
ExternalApi	external_controller_ping	GET /api/v1/external/ping	Ping (API key)
FeedbackApi	feedback_controller_create	POST /api/v1/feedback	Submit feedback
FeedbackApi	feedback_controller_find_all	GET /api/v1/feedback	List tenant feedback
HealthApi	health_controller_check	GET /api/v1/health	Health Check
HealthApi	health_controller_live	GET /api/v1/health/live	Liveness Check
HealthApi	health_controller_prometheus	GET /api/v1/health/metrics/prometheus	Prometheus text exposition (includes entitlement_* series)
HealthApi	health_controller_queues	GET /api/v1/health/queues	Queue Health Check (OWNER only)
HealthApi	health_controller_ready	GET /api/v1/health/ready	Readiness Check
HealthApi	health_controller_sentry_test	GET /api/v1/health/sentry-test	Sentry Test Endpoint (dev/staging only)
InvitationsApi	invitations_controller_accept	POST /api/v1/invitations/accept	Accept invitation (authenticated)
InvitationsApi	invitations_controller_preview	GET /api/v1/invitations/preview	Preview invitation (public)
MFAElevationApi	mfa_elevation_controller_create_challenge	POST /api/v1/mfa-elevation/challenge
MFAElevationApi	mfa_elevation_controller_verify	POST /api/v1/mfa-elevation/verify
NotificationsApi	notifications_controller_get_notifications	GET /api/v1/notifications	List Notifications
NotificationsApi	notifications_controller_get_unread_count	GET /api/v1/notifications/unread-count	Get Unread Count
NotificationsApi	notifications_controller_mark_all_as_read	PATCH /api/v1/notifications/read-all	Mark All as Read
NotificationsApi	notifications_controller_mark_as_read	PATCH /api/v1/notifications/{id}/read	Mark as Read
PresenceApi	presence_controller_heartbeat	POST /api/v1/users/heartbeat	Record user heartbeat
ProjectsApi	projects_controller_create	POST /api/v1/projects	Create Project
ProjectsApi	projects_controller_find_all	GET /api/v1/projects	List Projects
ProjectsApi	projects_controller_find_one	GET /api/v1/projects/{id}	Get Project
ProjectsApi	projects_controller_get_telemetry	GET /api/v1/projects/{id}/telemetry	Get Project Telemetry
ProjectsApi	projects_controller_remove	DELETE /api/v1/projects/{id}	Delete Project
ProjectsApi	projects_controller_update	PATCH /api/v1/projects/{id}	Update Project
PublicHealthApi	public_health_controller_get_public_health	GET /public/health
ReportsApi	reports_controller_create_schedule	POST /api/v1/reports/schedules
ReportsApi	reports_controller_delete_schedule	DELETE /api/v1/reports/schedules/{id}
ReportsApi	reports_controller_export_csv	GET /api/v1/reports/export/csv	Export CSV
ReportsApi	reports_controller_export_pdf	GET /api/v1/reports/export/pdf	Export PDF
ReportsApi	reports_controller_get_kpi	GET /api/v1/reports/kpi	Get KPI Summary
ReportsApi	reports_controller_get_timeseries	GET /api/v1/reports/timeseries	Get Timeseries Data
ReportsApi	reports_controller_get_top_resources	GET /api/v1/reports/top-resources	Get Top Resources
ReportsApi	reports_controller_list_schedules	GET /api/v1/reports/schedules
ReportsApi	reports_controller_update_schedule	PATCH /api/v1/reports/schedules/{id}
StorageApi	files_controller_abort_multipart	POST /api/v1/files/multipart/{fileId}/abort	Abort Multipart Upload
StorageApi	files_controller_bulk_delete	POST /api/v1/files/bulk-delete	Bulk Delete Files
StorageApi	files_controller_bulk_move	POST /api/v1/files/bulk-move	Bulk Move Files
StorageApi	files_controller_complete_multipart	POST /api/v1/files/multipart/{fileId}/complete	Complete Multipart Upload
StorageApi	files_controller_confirm_upload	POST /api/v1/files/confirm	Confirm Upload
StorageApi	files_controller_create_folder	POST /api/v1/files/folders	Create Folder
StorageApi	files_controller_delete_file	DELETE /api/v1/files/{fileId}	Delete File
StorageApi	files_controller_delete_folder	DELETE /api/v1/files/folders/{id}	Delete Folder
StorageApi	files_controller_download	GET /api/v1/files/{id}/download	Get Download URL (by id)
StorageApi	files_controller_generate_upload_url	POST /api/v1/files/upload-url	Generate Upload URL
StorageApi	files_controller_get_download_url	GET /api/v1/files/download-url	Get Download URL
StorageApi	files_controller_initiate_multipart	POST /api/v1/files/multipart/initiate	Initiate Multipart Upload
StorageApi	files_controller_list_files	GET /api/v1/files	List Files
StorageApi	files_controller_list_folders	GET /api/v1/files/folders	List Folders
StorageApi	files_controller_presign_parts	POST /api/v1/files/multipart/{fileId}/presign-parts	Presign Additional Parts
StorageApi	files_controller_profile_avatar_confirm	POST /api/v1/files/profile-avatar/confirm	Confirm profile photo upload
StorageApi	files_controller_profile_avatar_upload_url	POST /api/v1/files/profile-avatar/upload-url	Profile photo upload URL
StorageApi	files_controller_rename_folder	PATCH /api/v1/files/folders/{id}	Rename Folder
StorageApi	files_controller_update_file	PATCH /api/v1/files/{id}	Update File (rename/move/star/tags)
SuperAdminAuditApi	admin_audit_controller_global	GET /api/v1/admin/audit/global	Merged admin audit + tenant audit_logs (SQL UNION, optional tenant filter)
SuperAdminAuditApi	admin_audit_controller_list	GET /api/v1/admin/audit	Paginated platform admin audit log
SuperAdminAuthApi	super_admin_auth_controller_complete_mfa_enroll	POST /api/v1/admin/auth/mfa-enroll/complete	Complete MFA enrollment
SuperAdminAuthApi	super_admin_auth_controller_login	POST /api/v1/admin/auth/login	Super admin login
SuperAdminAuthApi	super_admin_auth_controller_logout	POST /api/v1/admin/auth/logout	Logout super admin (blacklist access token)
SuperAdminAuthApi	super_admin_auth_controller_mfa_verify	POST /api/v1/admin/auth/mfa/verify	Complete MFA for super admin session
SuperAdminAuthApi	super_admin_auth_controller_refresh_token	POST /api/v1/admin/auth/token/refresh	Issue a fresh access token while the session is still alive
SuperAdminAuthApi	super_admin_auth_controller_send_step_up_email_code	POST /api/v1/admin/auth/mfa/step-up/email-code	Send an email MFA code for a super-admin step-up challenge
SuperAdminAuthApi	super_admin_auth_controller_session	GET /api/v1/admin/auth/session	Current super admin session metadata
SuperAdminAuthApi	super_admin_auth_controller_start_mfa_enroll	POST /api/v1/admin/auth/mfa-enroll/start	Begin MFA enrollment (returns secret + otpauth URL)
SuperAdminAuthApi	super_admin_auth_controller_step_up	POST /api/v1/admin/auth/mfa/step-up	Refresh MFA step-up cache for sensitive admin actions
SuperAdminBillingApi	admin_billing_controller_cancel_from_body	POST /api/v1/admin/billing/cancel	Cancel subscription (body includes tenantId) — Paddle cancel + reconcile
SuperAdminBillingApi	admin_billing_controller_extend_trial	POST /api/v1/admin/billing/{tenantId}/extend-trial	Extend trialing subscription in Paddle
SuperAdminBillingApi	admin_billing_controller_force_cancel	POST /api/v1/admin/billing/{tenantId}/force-cancel	Cancel Paddle subscription immediately
SuperAdminBillingApi	admin_billing_controller_override_from_body	POST /api/v1/admin/billing/override	Override plan (body includes tenantId) — Paddle update + reconcile + override flag
SuperAdminBillingApi	admin_billing_controller_override_plan	POST /api/v1/admin/billing/{tenantId}/override-plan	Override tenant plan via Paddle + reconcile
SuperAdminBillingApi	admin_billing_controller_snapshot	GET /api/v1/admin/billing/{tenantId}	Billing snapshot (tenant, subscription, usage, override flags)
SuperAdminComplianceApi	admin_access_review_controller_export_csv	GET /api/v1/admin/access-review	Export platform access review CSV
SuperAdminDashboardApi	admin_dashboard_controller_summary	GET /api/v1/admin/dashboard/summary	Platform dashboard metrics
SuperAdminDashboardApi	admin_dashboard_metrics_controller_get_metrics	GET /api/v1/admin/dashboard/metrics	Extended platform dashboard metrics (all panels)
SuperAdminDashboardApi	admin_dashboard_metrics_controller_refresh_metrics	POST /api/v1/admin/dashboard/metrics/refresh	Bust metrics cache and return fresh data
SuperAdminFilesApi	admin_files_controller_bulk_delete_for_tenant	POST /api/v1/admin/tenants/{tenantId}/files/bulk-delete	Bulk delete tenant files (max 100 per request)
SuperAdminFilesApi	admin_files_controller_list	GET /api/v1/admin/files	List file entries across tenants (optional tenant filter)
SuperAdminFilesApi	admin_files_controller_list_for_tenant	GET /api/v1/admin/tenants/{tenantId}/files	List file entries for a tenant/workspace
SuperAdminFilesApi	admin_files_controller_remove	DELETE /api/v1/admin/files/{id}	Soft-delete file record and remove object from storage
SuperAdminFilesApi	admin_files_controller_remove_for_tenant	DELETE /api/v1/admin/tenants/{tenantId}/files/{fileId}	Delete a tenant file
SuperAdminFilesApi	admin_files_controller_set_quota_override	POST /api/v1/admin/tenants/{tenantId}/files/quota-override	Set or clear tenant file-size quota override
SuperAdminFilesApi	admin_files_controller_set_upload_lock	POST /api/v1/admin/tenants/{tenantId}/files/lock	Lock or unlock tenant uploads
SuperAdminImpersonationApi	impersonation_controller_elevate	POST /api/v1/admin/impersonate/elevate	Elevate impersonation to write mode (MFA)
SuperAdminImpersonationApi	impersonation_controller_exit	POST /api/v1/admin/impersonate/exit	End impersonation session
SuperAdminImpersonationApi	impersonation_controller_start	POST /api/v1/admin/impersonate/start	Start read-only impersonation session
SuperAdminImpersonationApi	impersonation_controller_start_for_tenant	POST /api/v1/admin/impersonate/{tenantId}	Start impersonation for a tenant (path alias for POST /admin/impersonate/start)
SuperAdminIntelligenceApi	admin_intelligence_controller_dismiss_action	POST /api/v1/admin/actions/{actionId}/dismiss	Dismiss an admin recommended action
SuperAdminIntelligenceApi	admin_intelligence_controller_execute_action	POST /api/v1/admin/actions/{actionId}/execute	Execute an admin recommended action
SuperAdminIntelligenceApi	admin_intelligence_controller_get_tenant_health	GET /api/v1/admin/tenants/{tenantId}/health	Get admin-only tenant health and recommendations
SuperAdminIntelligenceApi	admin_intelligence_controller_get_tenant_snapshot	GET /api/v1/admin/tenants/{tenantId}/snapshot	Raw operational snapshot for a tenant (no scoring)
SuperAdminIntelligenceApi	admin_intelligence_controller_list_attention	GET /api/v1/admin/attention	List open tenant attention queue items
SuperAdminMFAElevationApi	admin_mfa_elevation_controller_create_challenge	POST /api/v1/admin/mfa-elevation/challenge
SuperAdminMFAElevationApi	admin_mfa_elevation_controller_verify	POST /api/v1/admin/mfa-elevation/verify
SuperAdminPlatformApi	admin_platform_controller_billing_metrics_summary	GET /api/v1/admin/platform/billing-metrics	Estimated platform MRR from active subscription plan counts
SuperAdminPlatformApi	admin_platform_controller_cross_tenant_audit	GET /api/v1/admin/platform/cross-tenant-audit	Tenant audit_logs across all tenants, joined with tenant + user metadata
SuperAdminPlatformApi	admin_platform_controller_fix_plan_drift	POST /api/v1/admin/platform/plan-drift/{tenantId}/fix	Reconcile Tenant.plan to match Subscription.status reality
SuperAdminPlatformApi	admin_platform_controller_force_logout_all	POST /api/v1/admin/platform/tenants/{tenantId}/force-logout-all	Invalidate refresh tokens + Redis sessions for every user in a tenant
SuperAdminPlatformApi	admin_platform_controller_get_config	GET /api/v1/admin/platform/config	Get platform-wide configuration
SuperAdminPlatformApi	admin_platform_controller_list_plan_drift	GET /api/v1/admin/platform/plan-drift	Tenants where stored Tenant.plan doesn't match Subscription.status
SuperAdminPlatformApi	admin_platform_controller_module_registry_view	GET /api/v1/admin/platform/rbac/module-registry	Visualize canonical modules, permissions, roles, and tenant overrides
SuperAdminPlatformApi	admin_platform_controller_patch_config	PATCH /api/v1/admin/platform/config	Update platform-wide configuration
SuperAdminPlatformApi	admin_platform_controller_platform_search	GET /api/v1/admin/platform/search	Cross-entity admin search (tenants, users, audit)
SuperAdminPlatformApi	admin_platform_controller_set_tenant_role_permission_override	PATCH /api/v1/admin/platform/rbac/tenants/{tenantId}/role-permissions	Set or reset one built-in role permission override for a tenant
SuperAdminProjectsApi	admin_projects_controller_list	GET /api/v1/admin/projects	List projects (optional tenant filter)
SuperAdminProjectsApi	admin_projects_controller_remove	DELETE /api/v1/admin/projects/{id}	Delete a project (cascade API keys, etc.)
SuperAdminSettingsApi	super_admin_settings_controller_create_admin	POST /api/v1/admin/settings/admins	Create super admin
SuperAdminSettingsApi	super_admin_settings_controller_deactivate	POST /api/v1/admin/settings/admins/{id}/deactivate	Deactivate super admin
SuperAdminSettingsApi	super_admin_settings_controller_list_admins	GET /api/v1/admin/settings/admins	List super admins
SuperAdminSettingsApi	super_admin_settings_controller_update_capability_tier	PATCH /api/v1/admin/settings/admins/{id}/capability-tier	Update super admin capability tier
SuperAdminSupportApi	admin_support_controller_add_internal_note	POST /api/v1/admin/support/{ticketId}/internal-note	Add an internal support note
SuperAdminSupportApi	admin_support_controller_delete	DELETE /api/v1/admin/support/{ticketId}	Delete a support ticket
SuperAdminSupportApi	admin_support_controller_get	GET /api/v1/admin/support/{ticketId}	Get support ticket detail
SuperAdminSupportApi	admin_support_controller_list	GET /api/v1/admin/support	List support tickets
SuperAdminSupportApi	admin_support_controller_patch	PATCH /api/v1/admin/support/{ticketId}	Update support ticket triage fields
SuperAdminSupportApi	admin_support_controller_reply	POST /api/v1/admin/support/{ticketId}/reply	Reply to a support ticket
SuperAdminSupportApi	admin_support_controller_stats	GET /api/v1/admin/support/stats	Get support inbox stats
SuperAdminTenantActionsApi	tenant_actions_controller_api_access	POST /api/v1/admin/tenants/{tenantId}/api-access
SuperAdminTenantActionsApi	tenant_actions_controller_change_plan	POST /api/v1/admin/tenants/{tenantId}/change-plan	Change tenant plan by support
SuperAdminTenantActionsApi	tenant_actions_controller_end_impersonation	POST /api/v1/admin/tenants/{tenantId}/impersonation/end
SuperAdminTenantActionsApi	tenant_actions_controller_extend_grace	POST /api/v1/admin/tenants/{tenantId}/extend-grace	Extend billing grace period
SuperAdminTenantActionsApi	tenant_actions_controller_force_logout	POST /api/v1/admin/users/{userId}/force-logout
SuperAdminTenantActionsApi	tenant_actions_controller_force_purge	POST /api/v1/admin/tenants/{tenantId}/force-purge
SuperAdminTenantActionsApi	tenant_actions_controller_replay_webhook	POST /api/v1/admin/tenants/{tenantId}/webhooks/{webhookId}/deliveries/{deliveryId}/replay
SuperAdminTenantActionsApi	tenant_actions_controller_request_export	POST /api/v1/admin/tenants/{tenantId}/request-export
SuperAdminTenantActionsApi	tenant_actions_controller_reset_mfa	POST /api/v1/admin/users/{userId}/reset-mfa
SuperAdminTenantActionsApi	tenant_actions_controller_start_impersonation	POST /api/v1/admin/tenants/{tenantId}/impersonation/start
SuperAdminTenantActionsApi	tenant_actions_controller_suspend	POST /api/v1/admin/tenants/{tenantId}/suspend	Suspend tenant
SuperAdminTenantActionsApi	tenant_actions_controller_unsuspend	POST /api/v1/admin/tenants/{tenantId}/unsuspend	Unsuspend tenant
SuperAdminTenantActionsApi	tenant_actions_controller_upgrade_impersonation	POST /api/v1/admin/tenants/{tenantId}/impersonation/upgrade-write
SuperAdminTenantActionsApi	tenant_actions_controller_upload_restrictions	POST /api/v1/admin/tenants/{tenantId}/upload-restrictions
SuperAdminTenantsApi	admin_tenants_controller_billing	GET /api/v1/admin/tenants/{tenantId}/billing	Tenant billing snapshot
SuperAdminTenantsApi	admin_tenants_controller_detail	GET /api/v1/admin/tenants/{tenantId}	Tenant detail
SuperAdminTenantsApi	admin_tenants_controller_list	GET /api/v1/admin/tenants	List tenants
SuperAdminTenantsApi	admin_tenants_controller_members	GET /api/v1/admin/tenants/{tenantId}/members	Tenant members
SuperAdminTenantsApi	admin_tenants_controller_patch_status	PATCH /api/v1/admin/tenants/{tenantId}/status	Activate or suspend tenant (PATCH body: status + reason)
SuperAdminTenantsApi	admin_tenants_controller_patch_tenant	PATCH /api/v1/admin/tenants/{tenantId}	Update tenant metadata
SuperAdminTenantsApi	admin_tenants_controller_remove	DELETE /api/v1/admin/tenants/{tenantId}	Delete tenant
SuperAdminTenantsApi	admin_tenants_controller_remove_member	DELETE /api/v1/admin/tenants/{tenantId}/members/{membershipId}	Force-remove a member
SuperAdminTenantsApi	admin_tenants_controller_tenant_audit	GET /api/v1/admin/tenants/{tenantId}/audit	Tenant-facing audit logs (paginated)
SuperAdminTenantsApi	admin_tenants_controller_usage	GET /api/v1/admin/tenants/{tenantId}/usage	Tenant usage records
SuperAdminUsersApi	admin_users_controller_ban	POST /api/v1/admin/users/{userId}/ban	Globally ban a user
SuperAdminUsersApi	admin_users_controller_detail	GET /api/v1/admin/users/{userId}	Get a platform user detail bundle
SuperAdminUsersApi	admin_users_controller_force_verify_email	POST /api/v1/admin/users/{userId}/force-verify-email	Force verify a user's email
SuperAdminUsersApi	admin_users_controller_list	GET /api/v1/admin/users	List platform users or tenant memberships
SuperAdminUsersApi	admin_users_controller_patch_role	PATCH /api/v1/admin/users/{id}/role	Change a user's role within a tenant
SuperAdminUsersApi	admin_users_controller_remove	DELETE /api/v1/admin/users/{id}	Remove user from tenant (deletes membership; blocks last owner removal)
SuperAdminUsersApi	admin_users_controller_revoke_api_key	DELETE /api/v1/admin/users/{userId}/api-keys/{keyId}	Revoke a user's workspace API key
SuperAdminUsersApi	admin_users_controller_set_webhook_active	PATCH /api/v1/admin/users/{userId}/webhooks/{webhookId}	Enable or disable a user's workspace webhook
SuperAdminUsersApi	admin_users_controller_unban	POST /api/v1/admin/users/{userId}/unban	Restore access for a banned user
SuperAdminWorkspacesApi	admin_workspaces_controller_list	GET /api/v1/admin/workspaces	List child workspaces for a parent tenant
SuperAdminWorkspacesApi	admin_workspaces_controller_list_tenant_workspaces	GET /api/v1/admin/tenants/{tenantId}/workspaces	List root and child workspaces for a tenant
SuperAdminWorkspacesApi	admin_workspaces_controller_list_workspace_members	GET /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/members	List members for a tenant workspace
SuperAdminWorkspacesApi	admin_workspaces_controller_remove	DELETE /api/v1/admin/workspaces/{id}	Delete a workspace (child tenant) and all associated data (cascade)
SuperAdminWorkspacesApi	admin_workspaces_controller_remove_workspace_member	DELETE /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/members/{userId}
SuperAdminWorkspacesApi	admin_workspaces_controller_suspend_workspace	POST /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/suspend
SuperAdminWorkspacesApi	admin_workspaces_controller_transfer_ownership	POST /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/transfer-ownership
SuperAdminWorkspacesApi	admin_workspaces_controller_unsuspend_workspace	POST /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/unsuspend
SuperAdminWorkspacesApi	admin_workspaces_controller_update_workspace_member_role	PATCH /api/v1/admin/tenants/{tenantId}/workspaces/{workspaceId}/members/{userId}/role
SuperAdminEntitlementDriftApi	admin_entitlement_controller_extend_grace	POST /api/v1/admin/entitlement/extend-grace/{tenantId}	Extend graceExpiresAt by N days (GRACE workspaces only)
SuperAdminEntitlementDriftApi	admin_entitlement_controller_list_drift	GET /api/v1/admin/entitlement/drift	Workspaces currently in GRACE (quota excess)
SuperAdminEntitlementDriftApi	admin_entitlement_controller_pending_delete	GET /api/v1/admin/entitlement/pending-delete	Workspaces in PENDING_DELETE with deletion within the next 30 days
SuperAdminWebhookMetricsApi	admin_webhook_metrics_controller_get_metrics	GET /api/v1/admin/webhooks/metrics	Per-event delivery aggregates (platform-wide, read-only)
SuperAdminEntitlementDriftApi	entitlement_drift_controller_fix	POST /api/v1/admin/entitlement-drift/{tenantId}/fix	Fix entitlement drift for a tenant
SuperAdminEntitlementDriftApi	entitlement_drift_controller_list	GET /api/v1/admin/entitlement-drift	List tenants with entitlement drift
SuperAdminEntitlementDriftApi	entitlement_drift_controller_run_scan	POST /api/v1/admin/entitlement-drift/run-scan	Run entitlement drift detection on demand
SuperAdminEntitlementDriftApi	entitlement_drift_controller_summary	GET /api/v1/admin/entitlement-drift/summary	Get cached entitlement drift summary
SystemApi	app_controller_get_hello	GET /api/v1	Health Check
SystemApi	app_controller_test_error	GET /api/v1/test-error	Temporary Sentry test error
TeamApi	team_controller_accept	POST /api/v1/team/accept	Accept Invitation (public)
TeamApi	team_controller_assign_custom_role	PATCH /api/v1/team/members/{userId}/custom-role	Assign Custom Role
TeamApi	team_controller_invite	POST /api/v1/team/invite	Invite Member
TeamApi	team_controller_list_invitations	GET /api/v1/team/invitations	List Invitations
TeamApi	team_controller_remove_member	POST /api/v1/team/members/{id}/remove	Remove Member
TeamApi	team_controller_resend_invitation	POST /api/v1/team/invitations/{id}/resend	Resend Invitation
TeamApi	team_controller_revoke_invitation	POST /api/v1/team/invitations/{id}/revoke	Revoke Invitation
TeamApi	team_controller_update_member_role	PATCH /api/v1/team/members/{id}/role	Update Member Role
TeamApi	team_controller_verify_invitation	GET /api/v1/team/invitations/verify	Verify Invitation
TenantsApi	tenants_controller_complete_onboarding	PATCH /api/v1/tenants/complete-onboarding	Complete onboarding
TenantsApi	tenants_controller_create	POST /api/v1/tenants	Create tenant (super-admin)
TenantsApi	tenants_controller_create_role	POST /api/v1/tenants/me/roles	Create Custom Role
TenantsApi	tenants_controller_create_workspace	POST /api/v1/tenants/workspaces	Create Workspace
TenantsApi	tenants_controller_delete_workspace	DELETE /api/v1/tenants/workspaces/{childId}	Delete a workspace
TenantsApi	tenants_controller_download_compliance_export	GET /api/v1/tenants/me/governance/exports/{id}/download	Download completed compliance export JSON
TenantsApi	tenants_controller_find_all	GET /api/v1/tenants	List tenants (super-admin)
TenantsApi	tenants_controller_find_all_roles	GET /api/v1/tenants/me/roles	List Custom Roles
TenantsApi	tenants_controller_find_one	GET /api/v1/tenants/{id}	Get tenant (super-admin)
TenantsApi	tenants_controller_get_governance	GET /api/v1/tenants/me/governance	Workspace governance summary
TenantsApi	tenants_controller_get_my_settings	GET /api/v1/tenants/me/settings	Get My Settings
TenantsApi	tenants_controller_get_my_workspaces	GET /api/v1/tenants/workspaces	Get My Workspaces
TenantsApi	tenants_controller_get_workspace_data_export_status	GET /api/v1/tenants/workspaces/exports/{exportId}	Get workspace data export status
TenantsApi	tenants_controller_remove	DELETE /api/v1/tenants/{id}	Delete tenant (super-admin)
TenantsApi	tenants_controller_remove_role	DELETE /api/v1/tenants/me/roles/{id}	Delete custom role
TenantsApi	tenants_controller_request_compliance_export	POST /api/v1/tenants/me/governance/compliance-export	Request workspace compliance export
TenantsApi	tenants_controller_request_workspace_data_export	POST /api/v1/tenants/workspaces/{childId}/request-export	Request full workspace data export (Scale+)
TenantsApi	tenants_controller_revoke_workspace_sessions	POST /api/v1/tenants/me/governance/revoke-sessions	Revoke all refresh sessions for workspace members
TenantsApi	tenants_controller_update	PATCH /api/v1/tenants/{id}	Update tenant (super-admin)
TenantsApi	tenants_controller_update_branding	PATCH /api/v1/tenants/me/branding	Update Branding
TenantsApi	tenants_controller_update_me	PATCH /api/v1/tenants/me	Update Tenant
TenantsApi	tenants_controller_update_mfa_policy	PATCH /api/v1/tenants/me/governance/mfa-policy	Update workspace MFA enforcement policy
TenantsApi	tenants_controller_update_role	PATCH /api/v1/tenants/me/roles/{id}	Update custom role
UnsubscribeApi	unsubscribe_controller_confirm	POST /api/v1/unsubscribe/confirm	Confirm unsubscribe (public)
UnsubscribeApi	unsubscribe_controller_one_click	POST /api/v1/unsubscribe/one-click	RFC 8058 One-Click unsubscribe (public)
UnsubscribeApi	unsubscribe_controller_verify	GET /api/v1/unsubscribe/verify	Verify unsubscribe token (public)
UsageApi	usage_controller_get_api_calls	GET /api/v1/usage/api-calls	API calls time series
UsageApi	usage_controller_get_api_calls_detail	GET /api/v1/usage/api-calls/detail	API calls drill-down for dashboard sheet
UsageApi	usage_controller_get_recent_activity	GET /api/v1/usage/recent-activity	Recent workspace activity
UsageApi	usage_controller_get_storage	GET /api/v1/usage/storage	Storage usage breakdown
UsageApi	usage_controller_get_usage	GET /api/v1/usage	Dashboard usage totals
UsageApi	usage_controller_get_webhook_deliveries	GET /api/v1/usage/webhook-deliveries	Paginated webhook delivery log with filters
UsageApi	usage_controller_get_webhook_delivery	GET /api/v1/usage/webhook-delivery	Webhook delivery success vs failure by day
UsageApi	usage_controller_get_webhook_delivery_by_event	GET /api/v1/usage/webhook-delivery/by-event	Webhook delivery counts grouped by event type
UsageApi	usage_controller_get_webhooks_overview	GET /api/v1/usage/webhooks/overview	Webhook endpoints overview for dashboard sheet
UsersApi	users_controller_delete_me	DELETE /api/v1/users/me	Delete My Account
UsersApi	users_controller_export_my_data	GET /api/v1/users/me/export	Export My Data
UsersApi	users_controller_get_members	GET /api/v1/users/members	List Tenant Members
UsersApi	users_controller_get_profile	GET /api/v1/users/me	Get Current User
UsersApi	users_controller_get_user_by_id	GET /api/v1/users/{id}	Get User by ID
UsersApi	users_controller_patch_profile_avatar	PATCH /api/v1/users/me/avatar	Update profile photo
UsersApi	users_controller_soft_delete_user	DELETE /api/v1/users/{id}	Delete User
UsersApi	users_controller_update_profile	PATCH /api/v1/users/me	Update Profile
UsersApi	users_controller_update_user	PATCH /api/v1/users/{id}	Update User
WebhooksApi	webhooks_controller_delete_webhook	DELETE /api/v1/webhooks/{id}	Delete Webhook
WebhooksApi	webhooks_controller_get_deliveries	GET /api/v1/webhooks/{id}/deliveries	Get Webhook Deliveries
WebhooksApi	webhooks_controller_get_secret	GET /api/v1/webhooks/{id}/secret	Get Webhook Secret
WebhooksApi	webhooks_controller_list_all	GET /api/v1/webhooks	List Webhooks
WebhooksApi	webhooks_controller_list_events	GET /api/v1/webhooks/events	List outbound webhook event types
WebhooksApi	webhooks_controller_paddle_webhook_legacy	POST /api/v1/webhooks/paddle	Paddle webhook (legacy redirect)
WebhooksApi	webhooks_controller_regenerate_secret	POST /api/v1/webhooks/{id}/rotate-secret	Rotate Webhook Secret
WebhooksApi	webhooks_controller_register	POST /api/v1/webhooks	Register Webhook Endpoint
WebhooksApi	webhooks_controller_replay_delivery	POST /api/v1/webhooks/{id}/deliveries/{deliveryId}/replay	Replay a webhook delivery (admin)
WebhooksApi	webhooks_controller_test_ping	POST /api/v1/webhooks/{id}/test	Test Webhook
WebhooksApi	webhooks_controller_update	PATCH /api/v1/webhooks/{id}	Update Webhook
ApiKeysApi	api_keys_controller_create	POST /api/v1/projects/{projectId}/api-keys	Generate a new API key for a project
ApiKeysApi	api_keys_controller_create_global	POST /api/v1/api-keys	Create API Key
ApiKeysApi	api_keys_controller_find_all	GET /api/v1/api-keys	List API Keys
ApiKeysApi	api_keys_controller_find_all_for_project	GET /api/v1/projects/{projectId}/api-keys	List all API keys for a specific project
ApiKeysApi	api_keys_controller_find_one	GET /api/v1/api-keys/{keyId}	Get details of a specific API key (Global)
ApiKeysApi	api_keys_controller_find_one_in_project	GET /api/v1/projects/{projectId}/api-keys/{keyId}	Get details of a specific API key within a project
ApiKeysApi	api_keys_controller_get_logs	GET /api/v1/api-keys/{keyId}/logs	API Key Activity Logs
ApiKeysApi	api_keys_controller_regenerate	POST /api/v1/api-keys/{keyId}/regenerate	Rotate API Key
ApiKeysApi	api_keys_controller_remove	DELETE /api/v1/projects/{projectId}/api-keys/{keyId}	Revoke and delete an API key
ApiKeysApi	api_keys_controller_remove_global	DELETE /api/v1/api-keys/{keyId}	Revoke API Key
ExternalApiApi	external_controller_ping	GET /api/v1/external/ping	Ping (API key)

Documentation For Models

• AdminBillingCancelBodyDto
• AdminBillingOverrideBodyDto
• AdminBulkDeleteFilesDto
• AdminChangePlanDto
• AdminExtendGraceDto
• AdminExtendTrialDto
• AdminOverridePlanDto
• AdminReasonDto
• AdminSuspendTenantDto
• AdminTenantStatusPatchDto
• AdminUserRolePatchDto
• ApiAccessControlDto
• ApiKeysControllerCreateGlobalRequest
• AuthControllerLoginRequest
• AuthControllerRefreshRequest
• AuthControllerRegisterRequest
• BillingControllerChangePlanRequest
• CompleteMultipartDto
• CompleteMultipartPartDto
• ConfirmUnsubscribeDto
• CreateApiKeyDto
• CreateReportScheduleDto
• CreateSuperAdminDto
• DeleteSupportTicketDto
• EndImpersonationDto
• EntitlementExtendGraceDto
• EntitlementLimitsDto
• EntitlementUsageDto
• EntitlementsResponseDto
• ForceLogoutDto
• ForcePurgeDto
• ForgotPasswordDto
• HealthControllerCheck503Response
• HealthControllerCheck503ResponseInfoValue
• ImpersonateElevateDto
• ImpersonateStartDto
• InitiateMultipartDto
• PlanComparisonDto
• PlanHighlightDto
• PresignPartsDto
• ProjectsControllerCreateRequest
• ProjectsControllerUpdateRequest
• ReplayWebhookDto
• ReplySupportTicketDto
• RequestExportDto
• ResetMfaDto
• ResetPasswordDto
• SelectPrimaryDto
• StartImpersonationDto
• UpdateReportScheduleDto
• UpdateSuperAdminCapabilityDto
• UpgradeImpersonationDto
• UploadRestrictionsDto
• WebhooksControllerRegisterRequest
• WebhooksControllerUpdateRequest

Documentation For Authorization

Authentication schemes defined for the API:

JWT-auth

• Type: Bearer authentication (JWT)

access-token

• Type: Bearer authentication (JWT)

Author