user

Documentation

Index

• Constants
• func New(config *config.Config, processor processing.Processor) api.ClientModule
• type Module
  • func (m *Module) PasswordChangePOSTHandler(c *gin.Context)
  • func (m *Module) Route(r router.Router) error

Constants

const (
	// BasePath is the base URI path for this module
	BasePath = "/api/v1/user"
	// PasswordChangePath is the path for POSTing a password change request.
	PasswordChangePath = BasePath + "/password_change"
)

Functions

func New

func New(config *config.Config, processor processing.Processor) api.ClientModule

New returns a new user module

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module implements the ClientAPIModule interface

func (*Module) PasswordChangePOSTHandler

func (m *Module) PasswordChangePOSTHandler(c *gin.Context)

PasswordChangePOSTHandler swagger:operation POST /api/v1/user/password_change userPasswordChange

Change the password of authenticated user.

The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'. The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'.

--- tags: - user

consumes: - application/json - application/xml - application/x-www-form-urlencoded

produces: - application/json

security: - OAuth2 Bearer:

• write:user

responses:

'200':
  description: Change successful
'401':
   description: unauthorized
'403':
   description: forbidden
'400':
   description: bad request
'500':
   description: "internal error"

func (*Module) Route

func (m *Module) Route(r router.Router) error

Route attaches all routes from this module to the given router