interfaces

Documentation

Index

• Variables
• type DirectAuthForAdminProvider
  • func (ap *DirectAuthForAdminProvider) GetName() string
  • func (ap *DirectAuthForAdminProvider) GetSession(c *gin.Context) core.ISessionProvider
  • func (ap *DirectAuthForAdminProvider) GetUserFromRequest(c *gin.Context) core.IUser
  • func (ap *DirectAuthForAdminProvider) IsAuthenticated(c *gin.Context)
  • func (ap *DirectAuthForAdminProvider) Logout(c *gin.Context)
  • func (ap *DirectAuthForAdminProvider) Signin(c *gin.Context)
  • func (ap *DirectAuthForAdminProvider) Signup(c *gin.Context)
• type DirectAuthProvider
  • func (ap *DirectAuthProvider) GetName() string
  • func (ap *DirectAuthProvider) GetSession(c *gin.Context) core.ISessionProvider
  • func (ap *DirectAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser
  • func (ap *DirectAuthProvider) IsAuthenticated(c *gin.Context)
  • func (ap *DirectAuthProvider) Logout(c *gin.Context)
  • func (ap *DirectAuthProvider) Signin(c *gin.Context)
  • func (ap *DirectAuthProvider) Signup(c *gin.Context)
• type LoginParams
• type LoginParamsForUadminAdmin
• type SignupParams
• type SignupParamsForUadminAdmin
• type TokenAuthProvider
  • func (ap *TokenAuthProvider) GetName() string
  • func (ap *TokenAuthProvider) GetSession(c *gin.Context) core.ISessionProvider
  • func (ap *TokenAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser
  • func (ap *TokenAuthProvider) IsAuthenticated(c *gin.Context)
  • func (ap *TokenAuthProvider) Logout(c *gin.Context)
  • func (ap *TokenAuthProvider) Signin(c *gin.Context)
  • func (ap *TokenAuthProvider) Signup(c *gin.Context)
• type TokenLoginParams
• type TokenSignupParams
• type TokenWithExpirationAuthProvider
  • func (ap *TokenWithExpirationAuthProvider) GetName() string
  • func (ap *TokenWithExpirationAuthProvider) GetSession(c *gin.Context) core.ISessionProvider
  • func (ap *TokenWithExpirationAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser
  • func (ap *TokenWithExpirationAuthProvider) IsAuthenticated(c *gin.Context)
  • func (ap *TokenWithExpirationAuthProvider) Logout(c *gin.Context)
  • func (ap *TokenWithExpirationAuthProvider) Signin(c *gin.Context)
  • func (ap *TokenWithExpirationAuthProvider) Signup(c *gin.Context)
• type UserApiResponse

Variables

var GetUserForAPI = func(user core.IUser) *gin.H {
	if user == nil {
		return &gin.H{}
	}
	return &gin.H{"name": user.GetUsername(), "id": user.GetID()}
}

Types

type DirectAuthForAdminProvider

type DirectAuthForAdminProvider struct {
}

func (*DirectAuthForAdminProvider) GetName

func (ap *DirectAuthForAdminProvider) GetName() string

func (*DirectAuthForAdminProvider) GetSession

func (ap *DirectAuthForAdminProvider) GetSession(c *gin.Context) core.ISessionProvider

func (*DirectAuthForAdminProvider) GetUserFromRequest

func (ap *DirectAuthForAdminProvider) GetUserFromRequest(c *gin.Context) core.IUser

func (*DirectAuthForAdminProvider) IsAuthenticated

func (ap *DirectAuthForAdminProvider) IsAuthenticated(c *gin.Context)

func (*DirectAuthForAdminProvider) Logout

func (ap *DirectAuthForAdminProvider) Logout(c *gin.Context)

func (*DirectAuthForAdminProvider) Signin

func (ap *DirectAuthForAdminProvider) Signin(c *gin.Context)

func (*DirectAuthForAdminProvider) Signup

func (ap *DirectAuthForAdminProvider) Signup(c *gin.Context)

type DirectAuthProvider

type DirectAuthProvider struct {
}

func (*DirectAuthProvider) GetName

func (ap *DirectAuthProvider) GetName() string

func (*DirectAuthProvider) GetSession

func (ap *DirectAuthProvider) GetSession(c *gin.Context) core.ISessionProvider

func (*DirectAuthProvider) GetUserFromRequest

func (ap *DirectAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser

func (*DirectAuthProvider) IsAuthenticated

func (ap *DirectAuthProvider) IsAuthenticated(c *gin.Context)

func (*DirectAuthProvider) Logout

func (ap *DirectAuthProvider) Logout(c *gin.Context)

func (*DirectAuthProvider) Signin

func (ap *DirectAuthProvider) Signin(c *gin.Context)

func (*DirectAuthProvider) Signup

func (ap *DirectAuthProvider) Signup(c *gin.Context)

type LoginParams

type LoginParams struct {
	// SigninByField     string `form:"username" json:"username" xml:"username"  binding:"required"`
	SigninField string `form:"signinfield" json:"signinfield" xml:"signinfield"  binding:"required"`
	Password    string `form:"password" json:"password" xml:"password" binding:"required"`
	OTP         string `form:"otp" json:"otp" xml:"otp" binding:"omitempty"`
}

Binding from JSON

type LoginParamsForUadminAdmin

type LoginParamsForUadminAdmin struct {
	// SigninByField     string `form:"signinbyfield" json:"signinbyfield" xml:"signinbyfield"  binding:"required"`
	SigninField string `form:"signinfield" json:"signinfield" xml:"signinfield"  binding:"required"`
	Password    string `form:"password" json:"password" xml:"password" binding:"required"`
	OTP         string `form:"otp" json:"otp" xml:"otp" binding:"omitempty"`
}

Binding from JSON

type SignupParams

type SignupParams struct {
	Username          string `form:"username" json:"username" xml:"username"  binding:"required" valid:"username-unique"`
	Email             string `form:"email" json:"email" xml:"email"  binding:"required" valid:"email,email-unique"`
	Password          string `form:"password" json:"password" xml:"password" binding:"required"`
	ConfirmedPassword string `form:"confirm_password" json:"confirm_password" xml:"confirm_password" binding:"required"`
}

type SignupParamsForUadminAdmin

type SignupParamsForUadminAdmin struct {
	Username          string `form:"username" json:"username" xml:"username"  binding:"required" valid:"username-unique"`
	Email             string `form:"email" json:"email" xml:"email"  binding:"required" valid:"email,email-unique"`
	Password          string `form:"password" json:"password" xml:"password" binding:"required"`
	ConfirmedPassword string `form:"confirm_password" json:"confirm_password" xml:"confirm_password" binding:"required"`
}

type TokenAuthProvider

type TokenAuthProvider struct {
}

func (*TokenAuthProvider) GetName

func (ap *TokenAuthProvider) GetName() string

func (*TokenAuthProvider) GetSession

func (ap *TokenAuthProvider) GetSession(c *gin.Context) core.ISessionProvider

func (*TokenAuthProvider) GetUserFromRequest

func (ap *TokenAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser

func (*TokenAuthProvider) IsAuthenticated

func (ap *TokenAuthProvider) IsAuthenticated(c *gin.Context)

func (*TokenAuthProvider) Logout

func (ap *TokenAuthProvider) Logout(c *gin.Context)

func (*TokenAuthProvider) Signin

func (ap *TokenAuthProvider) Signin(c *gin.Context)

swagger:route POST /auth/token/signin auth token tokenSignin

Signs in user with provided credentials

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  default: generalError
  200: userApiResponse
  400: validationError

func (*TokenAuthProvider) Signup

func (ap *TokenAuthProvider) Signup(c *gin.Context)

swagger:route POST /auth/token/signup auth token tokenSignup

Signs in user with provided credentials

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  default: generalError
  200: userApiResponse
  400: validationError

type TokenLoginParams

type TokenLoginParams struct {
	// SigninByField     string `form:"username" json:"username" xml:"username"  binding:"required"`
	SigninField string `form:"signinfield" json:"signinfield" xml:"signinfield"  binding:"required"`
	Password    string `form:"password" json:"password" xml:"password" binding:"required"`
	OTP         string `form:"otp" json:"otp" xml:"otp" binding:"omitempty"`
}

swagger:parameters tokenSignin

type TokenSignupParams

type TokenSignupParams struct {
	Username          string `form:"username" json:"username" xml:"username"  binding:"required" valid:"username-unique"`
	Email             string `form:"email" json:"email" xml:"email"  binding:"required" valid:"email,email-unique"`
	Password          string `form:"password" json:"password" xml:"password" binding:"required"`
	ConfirmedPassword string `form:"confirm_password" json:"confirm_password" xml:"confirm_password" binding:"required"`
}

swagger:parameters tokenSignup

type TokenWithExpirationAuthProvider

type TokenWithExpirationAuthProvider struct {
}

func (*TokenWithExpirationAuthProvider) GetName

func (ap *TokenWithExpirationAuthProvider) GetName() string

func (*TokenWithExpirationAuthProvider) GetSession

func (ap *TokenWithExpirationAuthProvider) GetSession(c *gin.Context) core.ISessionProvider

func (*TokenWithExpirationAuthProvider) GetUserFromRequest

func (ap *TokenWithExpirationAuthProvider) GetUserFromRequest(c *gin.Context) core.IUser

func (*TokenWithExpirationAuthProvider) IsAuthenticated

func (ap *TokenWithExpirationAuthProvider) IsAuthenticated(c *gin.Context)

func (*TokenWithExpirationAuthProvider) Logout

func (ap *TokenWithExpirationAuthProvider) Logout(c *gin.Context)

func (*TokenWithExpirationAuthProvider) Signin

func (ap *TokenWithExpirationAuthProvider) Signin(c *gin.Context)

func (*TokenWithExpirationAuthProvider) Signup

func (ap *TokenWithExpirationAuthProvider) Signup(c *gin.Context)

type UserApiResponse

type UserApiResponse struct {
	Name string
	ID   uint
}

A UserApiResponse is a serialized view of the user swagger:response userApiResponse