package
1.0.2
Repository: https://github.com/pingcap/tiunimanager.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

CreateTenant create tenant interface @Summary created tenant @Description created tenant @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param CreateTenantReq body message.CreateTenantReq true "create tenant request parameter" @Success 200 {object} controller.CommonResult{data=message.CreateTenantResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenants/ [post].
CreateUser create user interface @Summary created user @Description created user @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param createUserReq body message.CreateUserReq true "create user request parameter" @Success 200 {object} controller.CommonResult{data=message.CreateUserResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/ [post].
DeleteTenant delete tenant interface @Summary delete tenant @Description delete tenant @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param tenantId path string true "tenant id" @Param DeleteTenantReq body message.DeleteTenantReq true "delete tenant request parameter" @Success 200 {object} controller.CommonResult{data=message.DeleteTenantResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenants/{tenantId} [delete].
DeleteUser delete user interface @Summary delete user @Description delete user @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param userId path string true "user id" @Param deleteUserReq body message.DeleteUserReq true "delete user request parameter" @Success 200 {object} controller.CommonResult{data=message.DeleteUserResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/{userId} [delete].
GetTenant get tenant profile interface @Summary get tenant profile @Description get tenant profile @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param tenantId path string true "tenant id" @Param GetTenantReq body message.GetTenantReq true "get tenant profile request parameter" @Success 200 {object} controller.CommonResult{data=message.GetTenantResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenant/{tenantId} [get].
GetUser get user profile interface @Summary get user profile @Description get user profile @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param userId path string true "user id" @Success 200 {object} controller.CommonResult{data=message.GetUserResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/{userId} [get].
Login login @Summary login @Description login @Tags platform @Accept application/json @Produce application/json @Param loginInfo body message.LoginReq true "login info" @Header 200 {string} Token "DUISAFNDHIGADS" @Success 200 {object} controller.CommonResult{data=message.LoginResp} @Failure 401 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /user/login [post].
Logout logout @Summary logout @Description logout @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Success 200 {object} controller.CommonResult{data=message.LogoutResp} @Failure 401 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /user/logout [post].
QueryTenants query all tenant profile interface @Summary queries all tenant profile @Description query all tenant profile @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param QueryTenantReq body message.QueryTenantReq true "query tenant profile request parameter" @Success 200 {object} controller.CommonResult{data=message.QueryTenantResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenant [get].
QueryUsers query all user profile interface @Summary queries all user profile @Description query all user profile @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param queryUserRequest body message.QueryUserReq true "query user profile request parameter" @Success 200 {object} controller.ResultWithPage{data=message.QueryUserResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/ [get].
UpdateTenantOnBoardingStatus update tenant onboarding status interface @Summary update tenant onboarding status @Description update tenant onboarding status @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param tenantId path string true "tenant id" @Param UpdateTenantOnBoardingStatusReq body message.UpdateTenantOnBoardingStatusReq true "query tenant profile request parameter" @Success 200 {object} controller.CommonResult{data=message.UpdateTenantOnBoardingStatusResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenant [post].
UpdateTenantProfile update tenant profile interface @Summary update tenant profile @Description update tenant profile @Tags user @Accept application/json @Produce application/json @Security ApiKeyAuth @Param tenantId path string true "tenant id" @Param UpdateTenantProfileReq body message.UpdateTenantProfileReq true "query tenant profile request parameter" @Success 200 {object} controller.CommonResult{data=message.UpdateTenantProfileResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /tenants/{tenantId}/update_profile [post].
UpdateUserPassword update user password interface @Summary update user password @Description update user password @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param userId path string true "user id" @Param UpdateUserPasswordRequest body message.UpdateUserPasswordReq true "query user password request parameter" @Success 200 {object} controller.CommonResult{data=message.UpdateUserPasswordResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/{userId}/password [post].
UpdateUserProfile update user profile interface @Summary update user profile @Description update user profile @Tags platform @Accept application/json @Produce application/json @Security ApiKeyAuth @Param userId path string true "user id" @Param updateUserProfileRequest body message.UpdateUserProfileReq true "query user profile request parameter" @Success 200 {object} controller.CommonResult{data=message.UpdateUserProfileResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /users/{userId}/update_profile [post].