apivalidation

Documentation

Index

• Constants
• type CheckRepresentation
  • func (c *CheckRepresentation) ConvertToDBCheck() dto.DBCheck
  • func (c *CheckRepresentation) IsIdentificationSuccessful() bool
  • func (c *CheckRepresentation) Validate() error
• type UserRepresentation
  • func (u *UserRepresentation) ExportToKeycloak(kcUser *kc.UserRepresentation)
  • func (u *UserRepresentation) HasUpdateOfAccreditationDependantInformationDB(formerUserInfo dto.DBUser) bool
  • func (u *UserRepresentation) HasUpdateOfAccreditationDependantInformationKC(formerUserInfo *kc.UserRepresentation) bool
  • func (u *UserRepresentation) ImportFromKeycloak(kcUser kc.UserRepresentation)
  • func (u *UserRepresentation) Validate() error

Constants

const (
	RegExpRealmName = constants.RegExpRealmName
	RegExpID        = constants.RegExpID
)

Parameter references

Types

type CheckRepresentation

type CheckRepresentation struct {
	UserID    *string    `json:"userId,omitempty"`
	Operator  *string    `json:"operator,omitempty"`
	DateTime  *time.Time `json:"datetime,omitempty"`
	Status    *string    `json:"status,omitempty"`
	Type      *string    `json:"type,omitempty"`
	Nature    *string    `json:"nature,omitempty"`
	ProofData *[]byte    `json:"proofData,omitempty"`
	ProofType *string    `json:"proofType,omitempty"`
}

CheckRepresentation struct

func (*CheckRepresentation) ConvertToDBCheck

func (c *CheckRepresentation) ConvertToDBCheck() dto.DBCheck

ConvertToDBCheck creates a DBCheck

func (*CheckRepresentation) IsIdentificationSuccessful

func (c *CheckRepresentation) IsIdentificationSuccessful() bool

IsIdentificationSuccessful tells whether a check is success or not

func (*CheckRepresentation) Validate

func (c *CheckRepresentation) Validate() error

Validate checks the validity of the given check

type UserRepresentation

type UserRepresentation struct {
	ID                   *string    `json:"id,omitempty"`
	Username             *string    `json:"username,omitempty"`
	Gender               *string    `json:"gender,omitempty"`
	FirstName            *string    `json:"firstName,omitempty"`
	LastName             *string    `json:"lastName,omitempty"`
	Email                *string    `json:"email,omitempty"`
	EmailVerified        *bool      `json:"emailVerified,omitempty"`
	PhoneNumber          *string    `json:"phoneNumber,omitempty"`
	PhoneNumberVerified  *bool      `json:"phoneNumberVerified,omitempty"`
	BirthDate            *time.Time `json:"birthDate,omitempty"`
	BirthLocation        *string    `json:"birthLocation,omitempty"`
	Nationality          *string    `json:"nationality,omitempty"`
	IDDocumentType       *string    `json:"idDocumentType,omitempty"`
	IDDocumentNumber     *string    `json:"idDocumentNumber,omitempty"`
	IDDocumentExpiration *time.Time `json:"idDocumentExpiration,omitempty"`
	IDDocumentCountry    *string    `json:"idDocumentCountry,omitempty"`
}

UserRepresentation struct

func (*UserRepresentation) ExportToKeycloak

func (u *UserRepresentation) ExportToKeycloak(kcUser *kc.UserRepresentation)

ExportToKeycloak exports user details into a Keycloak UserRepresentation

func (*UserRepresentation) HasUpdateOfAccreditationDependantInformationDB

func (u *UserRepresentation) HasUpdateOfAccreditationDependantInformationDB(formerUserInfo dto.DBUser) bool

HasUpdateOfAccreditationDependantInformationDB checks user data contains an update of accreditation-dependant information

func (*UserRepresentation) HasUpdateOfAccreditationDependantInformationKC

func (u *UserRepresentation) HasUpdateOfAccreditationDependantInformationKC(formerUserInfo *kc.UserRepresentation) bool

HasUpdateOfAccreditationDependantInformationKC checks user data contains an update of accreditation-dependant information

func (*UserRepresentation) ImportFromKeycloak

func (u *UserRepresentation) ImportFromKeycloak(kcUser kc.UserRepresentation)

ImportFromKeycloak import details from Keycloak

func (*UserRepresentation) Validate

func (u *UserRepresentation) Validate() error

Validate checks the validity of the given User