apicommunications

Documentation

Index

• func ExportEmailToKeycloak(r *EmailRepresentation) *kc.EmailRepresentation
• func ExportSMSToKeycloak(r *SMSRepresentation) *kc.SMSRepresentation
• type ActionRepresentation
• type AttachementRepresentation
• type EmailRepresentation
  • func EmailFromJSON(jsonRep string) (EmailRepresentation, error)
  • func ImportEmailFromKeycloak(kcRep *kc.EmailRepresentation) *EmailRepresentation
  • func (r *EmailRepresentation) EmailToJSON() string
  • func (r *EmailRepresentation) Validate() error
• type EmailThemingRepresentation
• type SMSRepresentation
  • func ImportSMSFromKeycloak(kcRep *kc.SMSRepresentation) *SMSRepresentation
  • func SMSFromJSON(jsonRep string) (SMSRepresentation, error)
  • func (r *SMSRepresentation) SMSToJSON() string
  • func (r *SMSRepresentation) Validate() error
• type SMSThemingRepresentation

Functions

func ExportEmailToKeycloak

func ExportEmailToKeycloak(r *EmailRepresentation) *kc.EmailRepresentation

ExportEmailToKeycloak exports the email representation into a Keycloak email representation

func ExportSMSToKeycloak

func ExportSMSToKeycloak(r *SMSRepresentation) *kc.SMSRepresentation

ExportSMSToKeycloak exports the SMS representation into a Keycloak SMS representation

Types

type ActionRepresentation

type ActionRepresentation struct {
	Name  *string `json:"name"`
	Scope *string `json:"scope"`
}

ActionRepresentation struct

type AttachementRepresentation

type AttachementRepresentation struct {
	Filename    *string `json:"filename,omitempty"`
	ContentType *string `json:"contentType,omitempty"`
	Content     *string `json:"content,omitempty"`
}

AttachementRepresentation struct

type EmailRepresentation

type EmailRepresentation struct {
	Recipient   *string                      `json:"recipient,omitempty"`
	Theming     *EmailThemingRepresentation  `json:"theming,omitempty"`
	Attachments *[]AttachementRepresentation `json:"attachments,omitempty"`
}

EmailRepresentation struct

func EmailFromJSON

func EmailFromJSON(jsonRep string) (EmailRepresentation, error)

EmailFromJSON creates an email using its json representation

func ImportEmailFromKeycloak

func ImportEmailFromKeycloak(kcRep *kc.EmailRepresentation) *EmailRepresentation

ImportEmailFromKeycloak imports the email representation from a Keycloak email representation

func (*EmailRepresentation) EmailToJSON

func (r *EmailRepresentation) EmailToJSON() string

EmailToJSON returns a json representation of a given Email

func (*EmailRepresentation) Validate

func (r *EmailRepresentation) Validate() error

Validate checks the validity of the given email

type EmailThemingRepresentation

type EmailThemingRepresentation struct {
	SubjectKey         *string            `json:"subjectKey,omitempty"`
	SubjectParameters  *[]string          `json:"subjectParameters,omitempty"`
	Template           *string            `json:"template,omitempty"`
	TemplateParameters *map[string]string `json:"templateParameters,omitempty"`
	Locale             *string            `json:"locale,omitempty"`
}

EmailThemingRepresentation struct

type SMSRepresentation

type SMSRepresentation struct {
	MSISDN  *string                   `json:"msisdn,omitempty"`
	Theming *SMSThemingRepresentation `json:"theming,omitempty"`
}

SMSRepresentation struct

func ImportSMSFromKeycloak

func ImportSMSFromKeycloak(kcRep *kc.SMSRepresentation) *SMSRepresentation

ImportSMSFromKeycloak exports the SMS representation into a Keycloak SMS representation

func SMSFromJSON

func SMSFromJSON(jsonRep string) (SMSRepresentation, error)

SMSFromJSON creates an sms using its json representation

func (*SMSRepresentation) SMSToJSON

func (r *SMSRepresentation) SMSToJSON() string

SMSToJSON returns a json representation of a given SMS

func (*SMSRepresentation) Validate

func (r *SMSRepresentation) Validate() error

Validate checks the validity of the given sms

type SMSThemingRepresentation

type SMSThemingRepresentation struct {
	MessageKey        *string   `json:"messageKey,omitempty"`
	MessageParameters *[]string `json:"messageParameters,omitempty"`
	Locale            *string   `json:"locale,omitempty"`
}

SMSThemingRepresentation struct