consent

Documentation

Index

• func RegisterHandler(e *echo.Echo, sessionService session.Service, service ServiceRead, ...)
• type Acr
• type ActiveConsent
• type AuthorisedConsent
• type Claims
• type Consent
• type Facade
  • func NewFacade(serviceRead ServiceRead, serviceWrite ServiceWrite, tokenService token.Service, ...) Facade
• type IdToken
• type Links
• type Meta
• type ObReadConsent
• type ObReadConsentData
• type ObReadConsentResponse
• type ObReadConsentResponseData
• type ObRisk
• type OpenBankingIntentId
• type RepositoryRead
  • func NewRepositoryRead(db *sqlx.DB) RepositoryRead
• type RepositoryWrite
  • func NewRepositoryWrite(db *sqlx.DB) RepositoryWrite
• type ServiceRead
  • func NewServiceRead(repo RepositoryRead) ServiceRead
• type ServiceWrite
  • func NewServiceWrite(repo RepositoryWrite) ServiceWrite
• type Token
• type TokensInConsent
• type Userinfo

Functions

func RegisterHandler

func RegisterHandler(e *echo.Echo, sessionService session.Service, service ServiceRead, facadeService Facade)

Types

type Acr

type Acr struct {
	Value     string `json:"value"`
	Essential bool   `json:"essential"`
}

******** TYPES OF AUTHORIZE CONSENT JWT *************

type ActiveConsent

type ActiveConsent struct {
	ConsentTid int64  `json:"consentTid"`
	AspspId    string `json:"aspspId"`
}

type AuthorisedConsent

type AuthorisedConsent struct {
	Iss          string `json:"iss"`
	Aud          string `json:"aud"`
	ResponseType string `json:"response_type"`
	ClientId     string `json:"client_id"`
	RedirectUri  string `json:"redirect_uri"`
	Scope        string `json:"scope"`
	Nonce        string `json:"nonce"`
	State        string `json:"state"`
	Exp          int64  `json:"exp"`
	Iat          int64  `json:"iat"`
	Claims       Claims `json:"claims"`
}

type Claims

type Claims struct {
	Userinfo Userinfo `json:"userinfo"`
	IdToken  IdToken  `json:"id_token"`
}

type Consent

type Consent struct {
	Id                             int64  `db:"id"`
	SessionReferenceId             string `db:"session_reference_id"`
	TrackingId                     string `db:"tracking_id"`
	AspspId                        string `db:"aspsp_id"`
	ConsentId                      string `db:"consent_id"`
	ConsentExpirationDateTime      string `db:"consent_expiration_date_time"`
	ConsentTransactionFromDateTime string `db:"consent_transaction_from_date_time"`
	ConsentTransactionToDateTime   string `db:"consent_transaction_to_date_time"`
	ConsentStatusUpdateDateTime    string `db:"consent_status_update_date_time"`
	CreateDateTime                 string `db:"create_date_time"`
	UpdateDateTime                 string `db:"update_date_time"`
	ConsentStatus                  string `db:"consent_status"`
	ConsentType                    string `db:"consent_type"`
	Tokens                         []Token
}

type Facade

type Facade interface {
	CreateConsent(sessionReferenceId, trackingId, aspspId string, consent *ObReadConsent) (string, error)
	GetConsent(cid, aspspId string) (string, error)
	DeleteConsent(consentId string) (string, error)
}

func NewFacade

func NewFacade(serviceRead ServiceRead, serviceWrite ServiceWrite, tokenService token.Service, cfg cfg.Service) Facade

type IdToken

type IdToken struct {
	OpenBankingIntentId OpenBankingIntentId `json:"openbanking_intent_id"`
	Acr                 Acr                 `json:"acr"`
}

type Links

type Links struct {
	Self  string `json:"Self"`
	First string `json:"First,omitempty"`
	Prev  string `json:"Prev,omitempty"`
	Next  string `json:"Next,omitempty"`
	Last  string `json:"Last,omitempty"`
}

Links relevant to the payload

type Meta

type Meta struct {
	TotalPages             int32  `json:"TotalPages,omitempty"`
	FirstAvailableDateTime string `json:"FirstAvailableDateTime,omitempty"`
	LastAvailableDateTime  string `json:"LastAvailableDateTime,omitempty"`
}

Meta Data relevant to the payload

type ObReadConsent

type ObReadConsent struct {
	Data *ObReadConsentData `json:"Data"`
	Risk *ObRisk            `json:"Risk"`
}

type ObReadConsentData

type ObReadConsentData struct {
	Permissions []string `json:"Permissions"`
	// Specified date and time the permissions will expire.
	//If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format.
	//All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
	ExpirationDateTime string `json:"ExpirationDateTime,omitempty"`
	// Specified start date and time for the transaction query period.
	//If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.
	//All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.
	//An example is below: 2017-04-05T10:43:07+00:00
	TransactionFromDateTime string `json:"TransactionFromDateTime,omitempty"`
	// Specified end date and time for the transaction query period.
	//If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.
	//All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.
	//An example is below: 2017-04-05T10:43:07+00:00
	TransactionToDateTime string `json:"TransactionToDateTime,omitempty"`
}

type ObReadConsentResponse

type ObReadConsentResponse struct {
	Data  *ObReadConsentResponseData `json:"Data"`
	Risk  *ObRisk                    `json:"Risk"`
	Links *Links                     `json:"Links,omitempty"`
	Meta  *Meta                      `json:"Meta,omitempty"`
}

type ObReadConsentResponseData

type ObReadConsentResponseData struct {
	// Unique identification as assigned to identify the account access consent resource.
	ConsentId        string `json:"ConsentId"`
	CreationDateTime string `json:"CreationDateTime"`
	// Specifies the status of consent resource in code form.
	Status               string   `json:"Status"`
	StatusUpdateDateTime string   `json:"StatusUpdateDateTime"`
	Permissions          []string `json:"Permissions"`
	// Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
	ExpirationDateTime time.Time `json:"ExpirationDateTime,omitempty"`
	// Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
	TransactionFromDateTime time.Time `json:"TransactionFromDateTime,omitempty"`
	// Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
	TransactionToDateTime time.Time `json:"TransactionToDateTime,omitempty"`
}

type ObRisk

type ObRisk struct {
}

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

type OpenBankingIntentId

type OpenBankingIntentId struct {
	Value     string `json:"value"`
	Essential bool   `json:"essential"`
}

type RepositoryRead

type RepositoryRead interface {
	// contains filtered or unexported methods
}

func NewRepositoryRead

func NewRepositoryRead(db *sqlx.DB) RepositoryRead

type RepositoryWrite

type RepositoryWrite interface {
	// contains filtered or unexported methods
}

func NewRepositoryWrite

func NewRepositoryWrite(db *sqlx.DB) RepositoryWrite

type ServiceRead

type ServiceRead interface {
	FindAuthorisedConsentByUserIdAndTppId(userId, tppId string) ([]ActiveConsent, error)
	FindByCid(consentId string) (*Consent, error)
	FindConsentByCidAndStatus(cid, status string) (*Consent, error)
	FindByTrackingId(trackingId string) (*Consent, error)
}

func NewServiceRead

func NewServiceRead(repo RepositoryRead) ServiceRead

type ServiceWrite

type ServiceWrite interface {
	ChangeConsentStateByCid(cid, status string) error
	InvalidateAuthorisedTokenByConsentTid(tid int64, status string) error
	SaveToken(token *Token) error
	SaveConsent(consent *Consent) error
}

func NewServiceWrite

func NewServiceWrite(repo RepositoryWrite) ServiceWrite

type Token

type Token struct {
	Id                      *int64  `db:"token_tid"`
	AccessToken             *string `db:"access_token"`
	ResourceAccessToken     *string `db:"resource_access_token"`
	ResourceRefreshToken    *string `db:"resource_refresh_token"`
	TokenStatus             *string `db:"token_status"`
	ExpiresIn               *int    `db:"expires_in"`
	CreateDateTime          *string `db:"create_date_time"`
	UpdateDateTime          *string `db:"update_date_time"`
	TokenExpirationDateTime *string `db:"token_expiration_date_time"`
	ConsentTid              *int64  `db:"consent_tid"`
}

type TokensInConsent

type TokensInConsent struct {
	Consent
	Token
}

type Userinfo

type Userinfo struct {
	OpenBankingIntentId OpenBankingIntentId `json:"openbanking_intent_id"`
}