administrator

Documentation

Index

• Constants
• Variables
• type Administrator
• type CheckPasswordRequest
• type CheckPasswordResponse
• type CreateRequest
• type CreateResponse
• type ForgotPasswordRequest
• type ForgotPasswordResponse
• type GetMyUserRequest
• type GetMyUserResponse
• type SetPasswordRequest
• type SetPasswordResponse
• type UpdateAllowedFieldsRequest
• type UpdateAllowedFieldsResponse
• type UpdatePasswordRequest
• type UpdatePasswordResponse

Constants

const CheckPasswordService = ServiceProvider + ".CheckPassword"

const CreateService = ServiceProvider + ".Create"

const ForgotPasswordService = ServiceProvider + ".ForgotPassword"

const GetMyUserService = ServiceProvider + ".GetMyUser"

const ServiceProvider = "HumanUser-Administrator"

const SetPasswordService = ServiceProvider + ".SetPassword"

const UpdateAllowedFieldsService = ServiceProvider + ".UpdateAllowedFields"

const UpdatePasswordService = ServiceProvider + ".UpdatePassword"

Variables

var ClientAdminUserPermissions = []api.Permission{
	UpdateAllowedFieldsService,
	CreateService,
	GetMyUserService,
	UpdatePasswordService,
	CheckPasswordService,
}

var ClientUserPermissions = []api.Permission{
	UpdateAllowedFieldsService,
	CreateService,
	GetMyUserService,
	UpdatePasswordService,
	CheckPasswordService,
}

var CompanyAdminUserPermissions = []api.Permission{
	UpdateAllowedFieldsService,
	CreateService,
	GetMyUserService,
	UpdatePasswordService,
	CheckPasswordService,
}

var CompanyUserPermissions = []api.Permission{
	UpdateAllowedFieldsService,
	CreateService,
	GetMyUserService,
	UpdatePasswordService,
	CheckPasswordService,
}

var SystemUserPermissions = make([]api.Permission, 0)

Types

type Administrator

type Administrator interface {
	GetMyUser(request *GetMyUserRequest) (*GetMyUserResponse, error)
	UpdateAllowedFields(request *UpdateAllowedFieldsRequest) (*UpdateAllowedFieldsResponse, error)
	Create(request *CreateRequest) (*CreateResponse, error)
	SetPassword(request *SetPasswordRequest) (*SetPasswordResponse, error)
	CheckPassword(request *CheckPasswordRequest) (*CheckPasswordResponse, error)
	UpdatePassword(request *UpdatePasswordRequest) (*UpdatePasswordResponse, error)
	ForgotPassword(request *ForgotPasswordRequest) (*ForgotPasswordResponse, error)
}

type CheckPasswordRequest

type CheckPasswordRequest struct {
	Claims   claims.Claims
	Password string
}

type CheckPasswordResponse

type CheckPasswordResponse struct {
	Result bool
}

type CreateRequest

type CreateRequest struct {
	Claims claims.Claims
	User   human.User
}

type CreateResponse

type CreateResponse struct {
	User human.User
}

type ForgotPasswordRequest

type ForgotPasswordRequest struct {
	UsernameOrEmailAddress string
}

type ForgotPasswordResponse

type ForgotPasswordResponse struct {
	URLToken string
}

type GetMyUserRequest

type GetMyUserRequest struct {
	Claims claims.Claims
}

type GetMyUserResponse

type GetMyUserResponse struct {
	User human.User
}

type SetPasswordRequest

type SetPasswordRequest struct {
	Claims      claims.Claims
	Identifier  identifier.Identifier
	NewPassword string
}

type SetPasswordResponse

type SetPasswordResponse struct {
}

type UpdateAllowedFieldsRequest

type UpdateAllowedFieldsRequest struct {
	Claims claims.Claims
	User   human.User
}

type UpdateAllowedFieldsResponse

type UpdateAllowedFieldsResponse struct {
	User human.User
}

type UpdatePasswordRequest

type UpdatePasswordRequest struct {
	Claims           claims.Claims
	ExistingPassword string
	NewPassword      string
}

type UpdatePasswordResponse

type UpdatePasswordResponse struct {
	User human.User
}