searchusers

Documentation

Index

• type OSSService
  • func ProvideUsersService(cfg *setting.Cfg, searchUserFilter user.SearchUserFilter, ...) *OSSService
  • func (s *OSSService) SearchUser(c *contextmodel.ReqContext) (*user.SearchUserQueryResult, error)
  • func (s *OSSService) SearchUsers(c *contextmodel.ReqContext) response.Response
  • func (s *OSSService) SearchUsersWithPaging(c *contextmodel.ReqContext) response.Response
• type SearchUsersResponse
• type SearchUsersWithPagingResponse
• type Service

Types

type OSSService

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

func ProvideUsersService

func ProvideUsersService(cfg *setting.Cfg, searchUserFilter user.SearchUserFilter, userService user.Service,
) *OSSService

func (*OSSService) SearchUser

func (s *OSSService) SearchUser(c *contextmodel.ReqContext) (*user.SearchUserQueryResult, error)

func (*OSSService) SearchUsers

func (s *OSSService) SearchUsers(c *contextmodel.ReqContext) response.Response

swagger:route GET /users users searchUsers

Get users.

Returns all users that the authenticated user has permission to view, admin permission required.

Responses: 200: searchUsersResponse 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*OSSService) SearchUsersWithPaging

func (s *OSSService) SearchUsersWithPaging(c *contextmodel.ReqContext) response.Response

swagger:route GET /users/search users searchUsersWithPaging

Get users with paging.

Responses: 200: searchUsersWithPagingResponse 401: unauthorisedError 403: forbiddenError 404: notFoundError 500: internalServerError

type SearchUsersResponse

type SearchUsersResponse struct {
	// The response message
	// in: body
	Body []*user.UserSearchHitDTO `json:"body"`
}

swagger:response searchUsersResponse

type SearchUsersWithPagingResponse

type SearchUsersWithPagingResponse struct {
	// The response message
	// in: body
	Body *user.SearchUserQueryResult `json:"body"`
}

swagger:response searchUsersWithPagingResponse

type Service

type Service interface {
	SearchUsers(c *contextmodel.ReqContext) response.Response
	SearchUsersWithPaging(c *contextmodel.ReqContext) response.Response
}