users

Documentation

Overview

Package users provides API services for users managing.

Index

• type ManagerPermissionsPart
• type ProfileEditToken
• type Service
  • func (srv *Service) SetRoutes(router chi.Router)

Types

type ManagerPermissionsPart

type ManagerPermissionsPart struct {
	CurrentUserIsManager bool `json:"-"`
	// returned only if the current user is a manager
	CurrentUserCanGrantUserAccess bool `json:"current_user_can_grant_user_access"`
	// returned only if the current user is a manager
	CurrentUserCanWatchUser bool `json:"current_user_can_watch_user"`
	// returned only if the current user is a manager
	// enum: none,view,edit
	PersonalInfoAccessApprovalToCurrentUser string `json:"personal_info_access_approval_to_current_user"`
}

ManagerPermissionsPart contains fields related to permissions for managing the user. These fields are only displayed if the current user is a manager of the user. swagger:ignore

type ProfileEditToken

type ProfileEditToken struct {
	// `loginID` of the user who requested the token.
	// required:true
	RequesterID string `json:"requester_id"`
	// `loginID` of the user whose profile is to be edited.
	// required:true
	TargetID string `json:"target_id"`
	// Expiry date in the number of seconds since 01/01/1970 UTC.
	// required:true
	Exp int64 `json:"exp,string"`
}

ProfileEditToken permits a requester user to edit the profile of a target user. swagger:model ProfileEditToken

type Service

type Service struct {
	*service.Base
}

Service is the mount point for services related to `users`.

func (*Service) SetRoutes

func (srv *Service) SetRoutes(router chi.Router)

SetRoutes defines the routes for this package in a route group.