v1

package
v1.4.0-alpha2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2024 License: Apache-2.0 Imports: 39 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckOIDCInit

func CheckOIDCInit() gin.HandlerFunc

func DeleteUser

func DeleteUser(c *gin.Context)

*

  • @description:
  • @param {path} id string "user id"
  • @method:DELETE
  • @router:/user/delete/:id

func DeleteUserAll

func DeleteUserAll(c *gin.Context)

func DeleteUserCustomConf

func DeleteUserCustomConf(c *gin.Context)

*

  • @description: delete user custom config
  • @param {path} key string
  • @method:delete
  • @router:/user/custom/:key

func DeleteUserImage

func DeleteUserImage(c *gin.Context)

func ExternalAPIMiddleware

func ExternalAPIMiddleware(c *gin.Context)

TODO Cant call login every request(using for testing only)

func GetOIDCSettings

func GetOIDCSettings(c *gin.Context)

func GetUserAllUsername

func GetUserAllUsername(c *gin.Context)

*

  • @description: get all Usernames
  • @method:GET
  • @router:/user/all/name

func GetUserAvatar

func GetUserAvatar(c *gin.Context)

@Summary get user head @Produce application/json @Tags user @Param file formData file true "用户头像" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /users/avatar [get]

func GetUserCustomConf

func GetUserCustomConf(c *gin.Context)

*

  • @description:get custom file by user
  • @param {path} name string "file name"
  • @method: GET
  • @router: /user/custom/:key

func GetUserImage

func GetUserImage(c *gin.Context)

*

  • @description: get current user's image
  • @method:GET
  • @router:/user/image/:id

func GetUserInfo

func GetUserInfo(c *gin.Context)

@Summary get user info @Produce application/json @Accept application/json @Tags user @Success 200 {string} string "ok" @Router /user/info/:id [get]

func GetUserInfoByUsername

func GetUserInfoByUsername(c *gin.Context)

*

  • @description:
  • @param {*gin.Context} c
  • @param {string} Username
  • @return {*}
  • @method:
  • @router:

func GetUserStatus

func GetUserStatus(c *gin.Context)

func InitOIDC

func InitOIDC()

func OIDC

func OIDC() error

Use an init function to initialize the oauth2Config variable.

func OIDCCallback

func OIDCCallback(c *gin.Context)

func OIDCHealthCheck

func OIDCHealthCheck(c *gin.Context)

func OIDCLogin

func OIDCLogin(c *gin.Context)

func OIDCLogout

func OIDCLogout(c *gin.Context)

func OIDCProfile

func OIDCProfile(c *gin.Context)

func OIDCUserInfo

func OIDCUserInfo(c *gin.Context)

func OIDCValidateToken

func OIDCValidateToken(c *gin.Context)

func OnePanelCreateWebsite

func OnePanelCreateWebsite(c *gin.Context)

func OnePanelDeleteWebsite

func OnePanelDeleteWebsite(c *gin.Context)

func OnePanelHealthCheck

func OnePanelHealthCheck(c *gin.Context)

func OnePanelLogin

func OnePanelLogin(c *gin.Context) error

func OnePanelUpdateProxyWebsite

func OnePanelUpdateProxyWebsite(c *gin.Context)
	response, cookies, err := service.MyService.OnePanel().Login(cred, onePanelServer)
	if err != nil {
		c.JSON(common_err.SERVICE_ERROR,
			model.Result{
				Success: common_err.SERVICE_ERROR,
				Message: common_err.GetMsg(common_err.SERVICE_ERROR),
			})
	}
	session := sessions.Default(c)
	for _, cookie := range cookies {
		session.Set(cookie.Name, cookie.Value)
		c.SetCookie(cookie.Name, cookie.Value, 3600, "/", "", false, true)
	}
	session.Save()
	c.JSON(common_err.SUCCESS,
		model.Result{
			Success: common_err.SUCCESS,
			Message: common_err.GetMsg(common_err.SUCCESS),
			Data:    response,
		})
}

func PostLogout

func PostLogout(c *gin.Context)

func PostOMVLogin

func PostOMVLogin(c *gin.Context)

@Summary login user to openmediavault @Produce application/json @Tags user @Param username password @Security SessionID @Success 200 {string} string "ok" @Router /users/omvLogin [post]

func PostUserCustomConf

func PostUserCustomConf(c *gin.Context)

*

  • @description:create or update custom conf by user
  • @param {path} name string "file name"
  • @method:POST
  • @router:/user/custom/:key

func PostUserLogin

func PostUserLogin(c *gin.Context)

func PostUserRefreshToken

func PostUserRefreshToken(c *gin.Context)

*

  • @description:
  • @param {*gin.Context} c
  • @param {string} refresh_token
  • @return {*}
  • @method:
  • @router:

func PostUserRegister

func PostUserRegister(c *gin.Context)

@Summary register user @Router /user/register/ [post]

func PostUserUploadImage

func PostUserUploadImage(c *gin.Context)

* * @description: * @param {*gin.Context} c * @param {file} file * @param {string} key * @param {string} type:avatar,background * @return {*} * @method: * @router:

func PutUserAvatar

func PutUserAvatar(c *gin.Context)

@Summary edit user head @Produce application/json @Accept multipart/form-data @Tags user @Param file formData file true "用户头像" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /users/avatar [put]

func PutUserDesc

func PutUserDesc(c *gin.Context)

@Summary edit user description @Produce application/json @Accept multipart/form-data @Tags user @Param description formData string false "Description" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/desc [put]

func PutUserImage

func PutUserImage(c *gin.Context)

*

  • @description:update user image
  • @method:POST
  • @router:/user/current/image/:key

func PutUserInfo

func PutUserInfo(c *gin.Context)

@Summary edit user name @Produce application/json @Accept application/json @Tags user @Param old_name query string true "Old user name" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/name/:id [put]

func PutUserNick

func PutUserNick(c *gin.Context)

@Summary edit user nick @Produce application/json @Accept application/json @Tags user @Param nick_name query string false "nick name" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/nick [put]

func PutUserPassword

func PutUserPassword(c *gin.Context)

@Summary edit user password @Produce application/json @Accept application/json @Tags user @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/password/:id [put]

func SaveOIDCSettings

func SaveOIDCSettings(c *gin.Context)

Types

type OIDCSetting

type OIDCSetting struct {
	Settings struct {
		ClientID     string `json:"clientId"`
		ClientSecret string `json:"clientSecret"`
		Issuer       string `json:"issuer"`
		AuthURL      string `json:"authUrl"`
		CallbackURL  string `json:"callbackUrl"`
	} `json:"settings"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL