Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ForceLogout ¶
@Summary 强制登出 @Description 对应的平台强制登出 @Tags 鉴权认证 @ID ForceLogout @Accept json @Param token header string true "im token" @Param req body api.ForceLogoutReq true "platform为平台ID <br> fromUserID为要执行强制登出的用户ID" @Produce json @Success 0 {object} api.ForceLogoutResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /auth/force_logout [post]
func ParseToken ¶
@Summary 解析当前用户token @Description 解析当前用户token(token在请求头中传入) @Tags 鉴权认证 @ID ParseToken @Accept json @Param token header string true "im token" @Param req body api.ParseTokenReq true "secret为openIM密钥, 详细见服务端config.yaml secret字段<br>platform为平台ID" @Produce json @Success 0 {object} api.ParseTokenResp{Data=api.ExpireTime} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /auth/parse_token [post]
func UserRegister ¶
@Summary 用户注册 @Description 用户注册 @Tags 鉴权认证 @ID UserRegister @Accept json @Param req body api.UserRegisterReq true "secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID <br> ex为拓展字段 <br> gender为性别, 0为女, 1为男" @Produce json @Success 0 {object} api.UserRegisterResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /auth/user_register [post]
func UserToken ¶
@Summary 用户登录 @Description 获取用户的token @Tags 鉴权认证 @ID UserToken @Accept json @Param req body api.UserTokenReq true "secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID" @Produce json @Success 0 {object} api.UserTokenResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /auth/user_token [post]
Types ¶
This section is empty.
Source Files