@autional/api-tenant
v0.4.0
Published
Autional Tenant API — auto-generated TypeScript client from tenant-service
Readme
@autional/api-tenant
Autional Tenant API — auto-generated TypeScript client from tenant-service (96 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminTenants(client, params?) | GET | /admin/tenants | 查询租户列表 |
| postAdminTenants(client, data: CreateTenantRequest) | POST | /admin/tenants | 创建租户 |
| getAdminTenantsStats(client) | GET | /admin/tenants/stats | 获取全部租户统计 |
| deleteAdminTenantsByTenants(client, tenantId: string) | DELETE | /admin/tenants/{tenant_id} | 删除租户 |
| getAdminTenantsByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id} | 获取租户详情 |
| putAdminTenantsByTenants(client, tenantId: string, data: UpdateTenantRequest) | PUT | /admin/tenants/{tenant_id} | 更新租户信息 |
| postAdminTenantsActivateByTenants(client, tenantId: string) | POST | /admin/tenants/{tenant_id}/activate | 激活租户 |
| getAdminTenantsApiKeysByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/api-keys | 列出租户 API Keys |
| postAdminTenantsApiKeysByTenants(client, tenantId: string, data: CreateApiKeyRequest) | POST | /admin/tenants/{tenant_id}/api-keys | 创建租户 API Key |
| deleteAdminTenantsApiKeysByTenantsByApiKeys(client, tenantId: string, keyId: string) | DELETE | /admin/tenants/{tenant_id}/api-keys/{key_id} | 吊销租户 API Key |
| postAdminTenantsApiKeysRotateByTenantsByApiKeys(client, tenantId: string, keyId: string) | POST | /admin/tenants/{tenant_id}/api-keys/{key_id}/rotate | 轮换租户 API Key |
| getAdminTenantsAppTypesByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/app-types | 列出应用类型 |
| postAdminTenantsAppTypesByTenants(client, tenantId: string, data: CreateAppTypeRequest) | POST | /admin/tenants/{tenant_id}/app-types | 创建自定义应用类型 |
| deleteAdminTenantsAppTypesByTenantsByAppTypes(client, tenantId: string, typeId: string) | DELETE | /admin/tenants/{tenant_id}/app-types/{type_id} | 删除应用类型 |
| putAdminTenantsAppTypesByTenantsByAppTypes(client, tenantId: string, typeId: string, data: UpdateAppTypeRequest) | PUT | /admin/tenants/{tenant_id}/app-types/{type_id} | 更新应用类型 |
| getAdminTenantsApplicationsByTenants(client, tenantId: string, params?) | GET | /admin/tenants/{tenant_id}/applications | 列出应用 |
| postAdminTenantsApplicationsByTenants(client, tenantId: string, data: CreateApplicationRequest) | POST | /admin/tenants/{tenant_id}/applications | 创建应用 |
| deleteAdminTenantsApplicationsByTenantsByApplications(client, tenantId: string, appId: string, params?) | DELETE | /admin/tenants/{tenant_id}/applications/{app_id} | 删除应用 |
| getAdminTenantsApplicationsByTenantsByApplications(client, tenantId: string, appId: string) | GET | /admin/tenants/{tenant_id}/applications/{app_id} | 获取应用详情 |
| putAdminTenantsApplicationsByTenantsByApplications(client, tenantId: string, appId: string, data: UpdateApplicationRequest) | PUT | /admin/tenants/{tenant_id}/applications/{app_id} | 更新应用 |
| postAdminTenantsApplicationsActivateByTenantsByApplications(client, tenantId: string, appId: string) | POST | /admin/tenants/{tenant_id}/applications/{app_id}/activate | 激活应用 |
| getAdminTenantsApplicationsMembersByTenantsByApplications(client, tenantId: string, appId: string, params?) | GET | /admin/tenants/{tenant_id}/applications/{app_id}/members | 列出应用成员 |
| postAdminTenantsApplicationsMembersByTenantsByApplications(client, tenantId: string, appId: string, data: AssignUserAppRoleRequest) | POST | /admin/tenants/{tenant_id}/applications/{app_id}/members | 分配用户应用角色 |
| deleteAdminTenantsApplicationsMembersByTenantsByApplicationsByMembers(client, tenantId: string, appId: string, userId: string) | DELETE | /admin/tenants/{tenant_id}/applications/{app_id}/members/{user_id} | 撤销用户应用角色 |
| putAdminTenantsApplicationsMembersByTenantsByApplicationsByMembers(client, tenantId: string, appId: string, userId: string, data: UpdateUserAppRoleRequest) | PUT | /admin/tenants/{tenant_id}/applications/{app_id}/members/{user_id} | 更新用户应用角色 |
| getAdminTenantsApplicationsRolesByTenantsByApplications(client, tenantId: string, appId: string) | GET | /admin/tenants/{tenant_id}/applications/{app_id}/roles | 列出应用默认角色 |
| postAdminTenantsApplicationsRolesByTenantsByApplications(client, tenantId: string, appId: string, data: CreateAppDefaultRoleRequest) | POST | /admin/tenants/{tenant_id}/applications/{app_id}/roles | 创建应用默认角色 |
| deleteAdminTenantsApplicationsRolesByTenantsByApplicationsByRoles(client, tenantId: string, appId: string, roleId: string) | DELETE | /admin/tenants/{tenant_id}/applications/{app_id}/roles/{role_id} | 删除应用默认角色 |
| getAdminTenantsApplicationsRolesByTenantsByApplicationsByRoles(client, tenantId: string, appId: string, roleId: string) | GET | /admin/tenants/{tenant_id}/applications/{app_id}/roles/{role_id} | 获取应用默认角色 |
| putAdminTenantsApplicationsRolesByTenantsByApplicationsByRoles(client, tenantId: string, appId: string, roleId: string, data: UpdateAppDefaultRoleRequest) | PUT | /admin/tenants/{tenant_id}/applications/{app_id}/roles/{role_id} | 更新应用默认角色 |
| postAdminTenantsApplicationsSuspendByTenantsByApplications(client, tenantId: string, appId: string, data: SuspendApplicationRequest) | POST | /admin/tenants/{tenant_id}/applications/{app_id}/suspend | 暂停应用 |
| getAdminTenantsAuthPolicyByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/auth-policy | 获取认证策略 |
| putAdminTenantsAuthPolicyByTenants(client, tenantId: string, data: UpdateAuthPolicyRequest) | PUT | /admin/tenants/{tenant_id}/auth-policy | 更新认证策略 |
| getAdminTenantsBrandingByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/branding | 获取品牌配置 |
| putAdminTenantsBrandingByTenants(client, tenantId: string, data: UpdateBrandingRequest) | PUT | /admin/tenants/{tenant_id}/branding | 更新品牌配置 |
| getAdminTenantsDataClassificationByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/data-classification | 查询租户数据分类分级 |
| postAdminTenantsDataClassificationByTenants(client, tenantId: string, data: UpdateDataClassificationRequest) | POST | /admin/tenants/{tenant_id}/data-classification | 更新租户数据分类分级 |
| getAdminTenantsDepartmentsByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/departments | 获取部门列表 |
| postAdminTenantsDepartmentsByTenants(client, tenantId: string, data: CreateDepartmentRequest) | POST | /admin/tenants/{tenant_id}/departments | 创建部门 |
| deleteAdminTenantsDepartmentsByTenantsByDepartments(client, tenantId: string, deptId: string) | DELETE | /admin/tenants/{tenant_id}/departments/{dept_id} | 删除部门 |
| putAdminTenantsDepartmentsByTenantsByDepartments(client, tenantId: string, deptId: string, data: UpdateDepartmentRequest) | PUT | /admin/tenants/{tenant_id}/departments/{dept_id} | 更新部门 |
| getAdminTenantsDomainsByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/domains | 获取域名列表 |
| postAdminTenantsDomainsByTenants(client, tenantId: string, data: AddDomainRequest) | POST | /admin/tenants/{tenant_id}/domains | 添加域名 |
| deleteAdminTenantsDomainsByTenantsByDomains(client, tenantId: string, domain: string) | DELETE | /admin/tenants/{tenant_id}/domains/{domain} | 删除域名 |
| putAdminTenantsFeaturedByTenants(client, tenantId: string, data: UpdateTenantFeaturedRequest) | PUT | /admin/tenants/{tenant_id}/featured | 设置租户精选 |
| getAdminTenantsInvitationCodesByTenants(client, tenantId: string, params?) | GET | /admin/tenants/{tenant_id}/invitation-codes | 列出租户邀请码 |
| postAdminTenantsInvitationCodesByTenants(client, tenantId: string, data: MintInvitationCodesRequest) | POST | /admin/tenants/{tenant_id}/invitation-codes | 批量铸造邀请码 |
| postAdminTenantsInvitationCodesRevokeByTenantsByInvitationCodes(client, tenantId: string, codeId: string) | POST | /admin/tenants/{tenant_id}/invitation-codes/{code_id}/revoke | 撤销邀请码 |
| getAdminTenantsInvitationConfigByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/invitation-config | 获取邀请配置 |
| putAdminTenantsInvitationConfigByTenants(client, tenantId: string, data: UpdateInvitationConfigRequest) | PUT | /admin/tenants/{tenant_id}/invitation-config | 更新邀请配置 |
| getAdminTenantsInvitationsByTenants(client, tenantId: string, params?) | GET | /admin/tenants/{tenant_id}/invitations | 获取邀请列表 |
| deleteAdminTenantsInvitationsByTenantsByInvitations(client, tenantId: string, inviteId: string) | DELETE | /admin/tenants/{tenant_id}/invitations/{invite_id} | 删除邀请 |
| postAdminTenantsInvitationsResendByTenantsByInvitations(client, tenantId: string, inviteId: string) | POST | /admin/tenants/{tenant_id}/invitations/{invite_id}/resend | 重新发送邀请 |
| postAdminTenantsInvitationsRevokeByTenantsByInvitations(client, tenantId: string, inviteId: string) | POST | /admin/tenants/{tenant_id}/invitations/{invite_id}/revoke | 撤销邀请 |
| getAdminTenantsMembersByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/members | 获取成员列表 |
| postAdminTenantsMembersByTenants(client, tenantId: string, data: AddMemberRequest) | POST | /admin/tenants/{tenant_id}/members | 添加成员 |
| postAdminTenantsMembersBatchApproveByTenants(client, tenantId: string, data: BatchApproveRequest) | POST | /admin/tenants/{tenant_id}/members/batch-approve | 批量审批成员 |
| postAdminTenantsMembersBulkImportByTenants(client, tenantId: string, data: BulkImportMembersRequest) | POST | /admin/tenants/{tenant_id}/members/bulk-import | 批量导入成员 |
| postAdminTenantsMembersInviteByTenants(client, tenantId: string, data: InviteMemberRequest) | POST | /admin/tenants/{tenant_id}/members/invite | 邀请成员 |
| getAdminTenantsMembersPendingByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/members/pending | 列出待审批成员 |
| deleteAdminTenantsMembersByTenantsByMembers(client, tenantId: string, memberId: string) | DELETE | /admin/tenants/{tenant_id}/members/{member_id} | 移除成员 |
| putAdminTenantsMembersByTenantsByMembers(client, tenantId: string, memberId: string, data: UpdateMemberRequest) | PUT | /admin/tenants/{tenant_id}/members/{member_id} | 更新成员信息 |
| postAdminTenantsMembersApproveByTenantsByMembers(client, tenantId: string, memberId: string, data: ApproveMemberRequest) | POST | /admin/tenants/{tenant_id}/members/{member_id}/approve | 通过成员审批 |
| postAdminTenantsMembersRejectByTenantsByMembers(client, tenantId: string, memberId: string, data: RejectMemberRequest) | POST | /admin/tenants/{tenant_id}/members/{member_id}/reject | 拒绝成员审批 |
| getAdminTenantsMinorsProtectionByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/minors-protection | 获取未成年人保护配置 |
| putAdminTenantsMinorsProtectionByTenants(client, tenantId: string, data: UpdateMinorsProtectionConfigRequest) | PUT | /admin/tenants/{tenant_id}/minors-protection | 更新未成年人保护配置 |
| getAdminTenantsOrgChartByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/org-chart | 获取组织架构图 |
| postAdminTenantsOrgChartByTenants(client, tenantId: string, data: UpdateOrgChartRequest) | POST | /admin/tenants/{tenant_id}/org-chart | 更新组织架构图 |
| getAdminTenantsQuotaByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/quota | 获取资源配额 |
| putAdminTenantsQuotaByTenants(client, tenantId: string, data: UpdateResourceQuotaRequest) | PUT | /admin/tenants/{tenant_id}/quota | 更新资源配额 |
| getAdminTenantsSecurityPolicyByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/security-policy | 获取安全策略 |
| putAdminTenantsSecurityPolicyByTenants(client, tenantId: string, data: UpdateSecurityPolicyRequest) | PUT | /admin/tenants/{tenant_id}/security-policy | 更新安全策略 |
| getAdminTenantsStatisticsByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/statistics | 获取租户统计概览 |
| postAdminTenantsSuspendByTenants(client, tenantId: string) | POST | /admin/tenants/{tenant_id}/suspend | 暂停租户 |
| getAdminTenantsWebhooksByTenants(client, tenantId: string) | GET | /admin/tenants/{tenant_id}/webhooks | 列出 Webhook |
| postAdminTenantsWebhooksByTenants(client, tenantId: string, data: CreateWebhookRequest) | POST | /admin/tenants/{tenant_id}/webhooks | 创建 Webhook |
| deleteAdminTenantsWebhooksByTenantsByWebhooks(client, tenantId: string, hookId: string) | DELETE | /admin/tenants/{tenant_id}/webhooks/{hook_id} | 删除 Webhook |
| getAdminTenantsWebhooksByTenantsByWebhooks(client, tenantId: string, hookId: string) | GET | /admin/tenants/{tenant_id}/webhooks/{hook_id} | 获取 Webhook 详情 |
| putAdminTenantsWebhooksByTenantsByWebhooks(client, tenantId: string, hookId: string, data: UpdateWebhookRequest) | PUT | /admin/tenants/{tenant_id}/webhooks/{hook_id} | 更新 Webhook |
| getAdminTenantsWebhooksDeliveriesByTenantsByWebhooks(client, tenantId: string, hookId: string, params?) | GET | /admin/tenants/{tenant_id}/webhooks/{hook_id}/deliveries | 列出 Webhook 投递记录 |
| getAdminTenantsWebhooksDeliveriesByTenantsByWebhooksByDeliveries(client, tenantId: string, hookId: string, deliveryId: string) | GET | /admin/tenants/{tenant_id}/webhooks/{hook_id}/deliveries/{delivery_id} | 获取投递详情 |
| postAdminTenantsWebhooksDeliveriesRetryByTenantsByWebhooksByDeliveries(client, tenantId: string, hookId: string, deliveryId: string) | POST | /admin/tenants/{tenant_id}/webhooks/{hook_id}/deliveries/{delivery_id}/retry | 重试投递 |
| postAdminTenantsWebhooksRotateSecretByTenantsByWebhooks(client, tenantId: string, hookId: string) | POST | /admin/tenants/{tenant_id}/webhooks/{hook_id}/rotate-secret | 轮换签名密钥 |
| getAdminTenantsWebhooksStatsByTenantsByWebhooks(client, tenantId: string, hookId: string) | GET | /admin/tenants/{tenant_id}/webhooks/{hook_id}/stats | 获取 Webhook 投递统计 |
| postAdminTenantsWebhooksTestByTenantsByWebhooks(client, tenantId: string, hookId: string) | POST | /admin/tenants/{tenant_id}/webhooks/{hook_id}/test | 测试 Webhook |
| getAdminWebhooksEventTypes(client) | GET | /admin/webhooks/event-types | 列出可用事件类型 |
| getAdminWebhooksEventTypesSchemaByEventTypes(client, event: string) | GET | /admin/webhooks/event-types/{event}/schema | 获取事件 Schema |
| postInvitationsAcceptByInvitations(client, token: string, data: AcceptInvitationRequest) | POST | /invitations/{token}/accept | 接受邀请 |
| getTenantPublicTenants(client, params?) | GET | /tenant/public/tenants | 公开租户列表 |
| postTenantPublicTenants(client, data: RegisterTrialTenantRequest) | POST | /tenant/public/tenants | 公开注册试用租户 |
| getTenantPublicTenantsBranding(client, params?) | GET | /tenant/public/tenants/branding | 公开租户品牌批量查询 |
| deleteTenantPublicTenantsByTenants(client, slug: string) | DELETE | /tenant/public/tenants/{slug} | 删除试用租户 |
| getTenantPublicTenantsByTenants(client, slug: string) | GET | /tenant/public/tenants/{slug} | 公开租户详情 |
| getTenantsApplicationsByTenants(client, tenantId: string, params?) | GET | /tenants/{tenant_id}/applications | 列出本租户应用 |
| getUsersApplicationsByUsers(client, userId: string) | GET | /users/{user_id}/applications | 获取用户可访问的应用列表 |
| getUsersTenantsByUsers(client, userId: string) | GET | /users/{user_id}/tenants | 获取用户所属租户列表 |
Install
npm install @autional/core @autional/api-tenantQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getAdminTenantsStats } from '@autional/api-tenant';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getAdminTenantsStats(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
