租户管理
租户管理 API 主要提供了关于系统租户的增删改查等功能,如创建新的租户、删除现有租户、修改租户信息以及查询租户详细信息等。
Maven坐标
xml
<dependency>
<groupId>com.ikingtech.platform</groupId>
<artifactId>sdk-tenant-api</artifactId>
</dependency>
接口详解
接口名称 | 接口地址 | 返回值 |
---|---|---|
添加租户 | /tenant/add | R<String> 类型,表示添加成功后的租户 ID。异常 : DUPLICATE_TENANT_NAME_OR_CODE: 已存在相同名称或标识的租户 |
删除租户 | /tenant/delete | R<Object> 类型,删除成功后返回成功状态 |
更新租户 | /tenant/update | R<Object> 类型,表示更新成功后的状态。异常 : TENANT_NOT_FOUND: 指定租户不存在。 DUPLICATE_TENANT_NAME_OR_CODE: 已存在相同名称或标识的租户。 INVALID_STATUS_TO_UPDATE: 初始化中和初始化失败时不可编辑 |
分页查询租户 | /tenant/page | R<List<TenantDTO>> 类型,表示分页查询到的租户列表 |
查询租户详情 | /tenant/detail | R<TenantDTO> 类型,表示查询到的租户详细信息 |
根据租户标识获取租户信息 | /tenant/getByCode | R<TenantDTO> 类型,表示查询到的租户详细信息 |
重置管理员密码 | /tenant/resetAdminPassword | R<TenantDTO> 类型,表示重置密码后的租户信息 |
查询当前登录用户的租户信息 | /tenant/listByCurrentUser | R<UserTenantDTO> 类型,表示查询到的当前登录用户的租户信息 |
数据迁移失败后的重试操作 | /tenant/retry | R<Object> 类型,表示重试操作后的状态。异常 : TENANT_NOT_FOUND: 指定租户不存在。 |
注意事项
所有接口在调用时都需要认证信息(如 token)以确保安全性。
在使用添加、删除和更新接口时,请确保传入的参数是有效的,否则可能会出现预料外的错误。
查询接口支持分页,可以根据需要自行设置查询条件和分页参数。