models

package
v0.0.0-...-6316459 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 4, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// ServiceTypeOauth2 captures enum value "oauth2"
	ServiceTypeOauth2 string = "oauth2"

	// ServiceTypeOidc captures enum value "oidc"
	ServiceTypeOidc string = "oidc"

	// ServiceTypeSystem captures enum value "system"
	ServiceTypeSystem string = "system"

	// ServiceTypeUser captures enum value "user"
	ServiceTypeUser string = "user"

	// ServiceTypeOpenbanking captures enum value "openbanking"
	ServiceTypeOpenbanking string = "openbanking"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptConsentRequest 

type AcceptConsentRequest struct {

	// List of accounts that user agreed to share on the consent page.
	AccountIds []string `json:"account_ids" yaml:"account_ids"`

	// granted scopes
	GrantedScopes GrantedScopes `json:"granted_scopes,omitempty" yaml:"granted_scopes,omitempty"`

	// Random string generated by Cloudentity used to mitigate Cross-site request forgery (CSRF) attacks.
	// Cloudentity sends state as login_state query param when redirecting to the consent page.
	// Example: \"cauq8fonbud6q8806bf0\
	LoginState string `json:"login_state,omitempty" yaml:"login_state,omitempty"`
}

AcceptConsentRequest accept consent request

swagger:model AcceptConsentRequest

func (*AcceptConsentRequest) ContextValidate 

func (m *AcceptConsentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this accept consent request based on the context it is used

func (*AcceptConsentRequest) MarshalBinary 

func (m *AcceptConsentRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AcceptConsentRequest) UnmarshalBinary 

func (m *AcceptConsentRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AcceptConsentRequest) Validate 

func (m *AcceptConsentRequest) Validate(formats strfmt.Registry) error

Validate validates this accept consent request

type AuthenticationContext 

type AuthenticationContext map[string]interface{}

AuthenticationContext authentication context

swagger:model AuthenticationContext

func (AuthenticationContext) ContextValidate 

func (m AuthenticationContext) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this authentication context based on context it is used

func (AuthenticationContext) Validate 

func (m AuthenticationContext) Validate(formats strfmt.Registry) error

Validate validates this authentication context

type ClientInfo 

type ClientInfo struct {

	// Human-readable name of a client application.
	// Example: My app
	ClientName string `json:"client_name,omitempty" yaml:"client_name,omitempty"`

	// URI of a client application.
	ClientURI string `json:"client_uri,omitempty" yaml:"client_uri,omitempty"`

	// Description of the client application.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// Logo URI.
	LogoURI string `json:"logo_uri,omitempty" yaml:"logo_uri,omitempty"`

	// External organization identifier. It is a unique string assigned by the CDR Register to identify an Accredited
	// Data Recipient Brand.
	//
	// The value obtained is used as the `aud` claim for message signing, for example, when a JSON Web Token (JWT) is
	// required for authorization, and represents the audience(s) the JWT is intended for.
	// Example: 5647fe90-f6bc-11eb-9a03-0242ac130003
	OrganisationID string `json:"organisation_id,omitempty" yaml:"organisation_id,omitempty"`

	// Policy URL to read about how the profile data is used.
	PolicyURI string `json:"policy_uri,omitempty" yaml:"policy_uri,omitempty"`

	// Terms of Service URL.
	TosURI string `json:"tos_uri,omitempty" yaml:"tos_uri,omitempty"`
}

ClientInfo client info

swagger:model ClientInfo

func (*ClientInfo) ContextValidate 

func (m *ClientInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this client info based on context it is used

func (*ClientInfo) MarshalBinary 

func (m *ClientInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClientInfo) UnmarshalBinary 

func (m *ClientInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClientInfo) Validate 

func (m *ClientInfo) Validate(formats strfmt.Registry) error

Validate validates this client info

type ConsentAccepted 

type ConsentAccepted struct {

	// A URL to redirect the user.
	// It applies for the redirect flow only, i.e the consent page.
	// Example: https://authorization.cloudentity.com:8443/tenant/server/oauth2/authorize?client_id=bugkgm23g9kregtu051g\u0026consent_verified=true\u0026login_id=cavai7d8s9nelp7k792g\u0026login_state=cauq8fonbud6q8806bf0
	RedirectTo string `json:"redirect_to,omitempty" yaml:"redirect_to,omitempty"`
}

ConsentAccepted consent accepted

swagger:model ConsentAccepted

func (*ConsentAccepted) ContextValidate 

func (m *ConsentAccepted) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this consent accepted based on context it is used

func (*ConsentAccepted) MarshalBinary 

func (m *ConsentAccepted) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ConsentAccepted) UnmarshalBinary 

func (m *ConsentAccepted) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ConsentAccepted) Validate 

func (m *ConsentAccepted) Validate(formats strfmt.Registry) error

Validate validates this consent accepted

type ConsentRejected 

type ConsentRejected struct {

	// A URL to redirect the user.
	// It applies for the redirect flow only, i.e the consent page.
	// Example: https://authorization.cloudentity.com:8443/tenant/server/oauth2/authorize?client_id=bugkgm23g9kregtu051g\u0026consent_verified=true\u0026login_id=cavai7d8s9nelp7k792g\u0026login_state=cauq8fonbud6q8806bf0
	RedirectTo string `json:"redirect_to,omitempty" yaml:"redirect_to,omitempty"`
}

ConsentRejected consent rejected

swagger:model ConsentRejected

func (*ConsentRejected) ContextValidate 

func (m *ConsentRejected) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this consent rejected based on context it is used

func (*ConsentRejected) MarshalBinary 

func (m *ConsentRejected) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ConsentRejected) UnmarshalBinary 

func (m *ConsentRejected) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ConsentRejected) Validate 

func (m *ConsentRejected) Validate(formats strfmt.Registry) error

Validate validates this consent rejected

type ConsentStatus 

type ConsentStatus string

ConsentStatus consent status

swagger:model ConsentStatus

func (ConsentStatus) ContextValidate 

func (m ConsentStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this consent status based on context it is used

func (ConsentStatus) Validate 

func (m ConsentStatus) Validate(formats strfmt.Registry) error

Validate validates this consent status

type ConsentType 

type ConsentType string

ConsentType consent type

swagger:model ConsentType

func (ConsentType) ContextValidate 

func (m ConsentType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this consent type based on context it is used

func (ConsentType) Validate 

func (m ConsentType) Validate(formats strfmt.Registry) error

Validate validates this consent type

type ConsentsRemovedResponse 

type ConsentsRemovedResponse struct {

	// number of consents removed
	NumberOfConsentsRemoved int64 `json:"number_of_consents_removed,omitempty" yaml:"number_of_consents_removed,omitempty"`
}

ConsentsRemovedResponse consents removed response

swagger:model ConsentsRemovedResponse

func (*ConsentsRemovedResponse) ContextValidate 

func (m *ConsentsRemovedResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this consents removed response based on context it is used

func (*ConsentsRemovedResponse) MarshalBinary 

func (m *ConsentsRemovedResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ConsentsRemovedResponse) UnmarshalBinary 

func (m *ConsentsRemovedResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ConsentsRemovedResponse) Validate 

func (m *ConsentsRemovedResponse) Validate(formats strfmt.Registry) error

Validate validates this consents removed response

type Error 

type Error struct {

	// details
	Details interface{} `json:"details,omitempty" yaml:"details,omitempty"`

	// error
	Error string `json:"error,omitempty" yaml:"error,omitempty"`

	// error code
	ErrorCode string `json:"error_code,omitempty" yaml:"error_code,omitempty"`

	// status code
	StatusCode int64 `json:"status_code,omitempty" yaml:"status_code,omitempty"`
}

Error HTTP error response

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type GetKSAConsentResponse 

type GetKSAConsentResponse struct {

	// List of account identifiers
	AccountIds []string `json:"account_ids" yaml:"account_ids"`

	// authentication context
	AuthenticationContext AuthenticationContext `json:"authentication_context,omitempty" yaml:"authentication_context,omitempty"`

	// Client application identifier.
	// Example: \"cauqo9c9vpbs0aj2b2v0\
	ClientID string `json:"client_id,omitempty" yaml:"client_id,omitempty"`

	// client info
	ClientInfo *ClientInfo `json:"client_info,omitempty" yaml:"client_info,omitempty"`

	// consent id
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// Consent creation time
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`

	// ksa consent
	KsaConsent *KSAConsent `json:"ksa_consent,omitempty" yaml:"ksa_consent,omitempty"`

	// List of requested scopes
	RequestedScopes []*RequestedScope `json:"requested_scopes" yaml:"requested_scopes"`

	// Server / Workspace identifier.
	// Example: \"server\
	ServerID string `json:"server_id,omitempty" yaml:"server_id,omitempty"`

	// Consent status
	Status string `json:"status,omitempty" yaml:"status,omitempty"`

	// Subject
	Subject string `json:"subject,omitempty" yaml:"subject,omitempty"`

	// Tenant identifier.
	// Example: \"tenant\
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// type
	Type ConsentType `json:"type,omitempty" yaml:"type,omitempty"`
}

GetKSAConsentResponse get k s a consent response

swagger:model GetKSAConsentResponse

func (*GetKSAConsentResponse) ContextValidate 

func (m *GetKSAConsentResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get k s a consent response based on the context it is used

func (*GetKSAConsentResponse) MarshalBinary 

func (m *GetKSAConsentResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetKSAConsentResponse) UnmarshalBinary 

func (m *GetKSAConsentResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetKSAConsentResponse) Validate 

func (m *GetKSAConsentResponse) Validate(formats strfmt.Registry) error

Validate validates this get k s a consent response

type GrantedScopes 

type GrantedScopes []string

GrantedScopes granted scopes

swagger:model GrantedScopes

func (GrantedScopes) ContextValidate 

func (m GrantedScopes) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this granted scopes based on context it is used

func (GrantedScopes) Validate 

func (m GrantedScopes) Validate(formats strfmt.Registry) error

Validate validates this granted scopes

type KSAConsent 

type KSAConsent struct {

	// Client application identifier
	// Example: bugkgm23g9kregtu051g
	ClientID string `json:"client_id,omitempty" yaml:"client_id,omitempty"`

	// Consent identifier
	// Example: cavbbioiagh6fla7koig
	ConsentID string `json:"consent_id,omitempty" yaml:"consent_id,omitempty"`

	// Consent creation date
	// Example: 2022-07-01T08:52:27.127932Z
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`

	// Consent expiration date
	// Example: 2023-03-01T09:02:27.127932Z
	// Format: date-time
	Expiry strfmt.DateTime `json:"expiry,omitempty" yaml:"expiry,omitempty"`

	// Workspace identifier
	// Example: server
	ServerID string `json:"server_id,omitempty" yaml:"server_id,omitempty"`

	// status
	Status ConsentStatus `json:"status,omitempty" yaml:"status,omitempty"`

	// Tenant identifier
	// Example: my-company
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
}

KSAConsent k s a consent

swagger:model KSAConsent

func (*KSAConsent) ContextValidate 

func (m *KSAConsent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this k s a consent based on the context it is used

func (*KSAConsent) MarshalBinary 

func (m *KSAConsent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*KSAConsent) UnmarshalBinary 

func (m *KSAConsent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*KSAConsent) Validate 

func (m *KSAConsent) Validate(formats strfmt.Registry) error

Validate validates this k s a consent

type Metadata 

type Metadata map[string]interface{}

Metadata metadata

swagger:model Metadata

func (Metadata) ContextValidate 

func (m Metadata) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this metadata based on context it is used

func (Metadata) Validate 

func (m Metadata) Validate(formats strfmt.Registry) error

Validate validates this metadata

type RejectConsentRequest 

type RejectConsentRequest struct {

	// Rejection error indication.
	// Example: Rejected
	Error string `json:"error,omitempty" yaml:"error,omitempty"`

	// Rejection cause.
	// Example: Rejected by the user.
	ErrorCause string `json:"error_cause,omitempty" yaml:"error_cause,omitempty"`

	// Rejection error description.
	// Example: The user rejected authentication.
	ErrorDescription string `json:"error_description,omitempty" yaml:"error_description,omitempty"`

	// Login identifier.
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// Random string generated by Cloudentity used to mitigate cross-site request forgery (CSRF) attacks.
	// Cloudentity sends state as the `login_state` query parameter when redirecting to the consent page.
	// Example: cauq8fonbud6q8806bf0
	LoginState string `json:"login_state,omitempty" yaml:"login_state,omitempty"`

	// Rejection HTTP status code.
	// Example: 403
	StatusCode int64 `json:"status_code,omitempty" yaml:"status_code,omitempty"`
}

RejectConsentRequest reject consent request

swagger:model RejectConsentRequest

func (*RejectConsentRequest) ContextValidate 

func (m *RejectConsentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this reject consent request based on context it is used

func (*RejectConsentRequest) MarshalBinary 

func (m *RejectConsentRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RejectConsentRequest) UnmarshalBinary 

func (m *RejectConsentRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RejectConsentRequest) Validate 

func (m *RejectConsentRequest) Validate(formats strfmt.Registry) error

Validate validates this reject consent request

type RequestedScope 

type RequestedScope struct {

	// Authorization server identifier
	// Example: my-server
	AuthorizationServerID string `json:"authorization_server_id,omitempty" yaml:"authorization_server_id,omitempty"`

	// The scope description displayed as a hint on a consent page
	// Example: This scope value requests offline access using refresh token
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// The scope name displayed on a consent page
	// Example: Offline Access
	DisplayName string `json:"display_name,omitempty" yaml:"display_name,omitempty"`

	// Scope identifier
	// Example: scope-1
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// Request this scope by default for all clients who subscribed to this scope
	Implicit bool `json:"implicit,omitempty" yaml:"implicit,omitempty"`

	// Do not ask for consent for this scope
	ImplicitGrant bool `json:"implicit_grant,omitempty" yaml:"implicit_grant,omitempty"`

	// metadata
	Metadata Metadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	// Scope name
	// Example: offline_access
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// params
	Params []string `json:"params" yaml:"params"`

	// requested name
	RequestedName string `json:"requested_name,omitempty" yaml:"requested_name,omitempty"`

	// service
	Service *Service `json:"service,omitempty" yaml:"service,omitempty"`

	// Tenant identifier
	// Example: my-company
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// Disable storage of scope grants
	Transient bool `json:"transient,omitempty" yaml:"transient,omitempty"`

	// with service
	WithService bool `json:"with_service,omitempty" yaml:"with_service,omitempty"`
}

RequestedScope requested scope

swagger:model RequestedScope

func (*RequestedScope) ContextValidate 

func (m *RequestedScope) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this requested scope based on the context it is used

func (*RequestedScope) MarshalBinary 

func (m *RequestedScope) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RequestedScope) UnmarshalBinary 

func (m *RequestedScope) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RequestedScope) Validate 

func (m *RequestedScope) Validate(formats strfmt.Registry) error

Validate validates this requested scope

type Service 

type Service struct {

	// Authorization server identifier
	// Example: my-server
	AuthorizationServerID string `json:"authorization_server_id,omitempty" yaml:"authorization_server_id,omitempty"`

	// Custom service audience
	// Example: https://api.example.com
	CustomAudience string `json:"custom_audience,omitempty" yaml:"custom_audience,omitempty"`

	// Service description
	// Example: Service description
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	// Gateway identifier
	// Example: gateway-1
	GatewayID string `json:"gateway_id,omitempty" yaml:"gateway_id,omitempty"`

	// A unique identifier of a service
	// Example: service-1
	ID string `json:"id,omitempty" yaml:"id,omitempty"`

	// Service name
	// Example: My service
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// `true` when the service is a system service
	// Example: false
	System bool `json:"system,omitempty" yaml:"system,omitempty"`

	// Tenant identifier
	// Example: my-company
	TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`

	// Service type
	// Enum: ["oauth2","oidc","system","user","openbanking"]
	Type string `json:"type,omitempty" yaml:"type,omitempty"`

	// The date of service update
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`

	// `true` when the service has the OpenAPI 3.0 specification
	WithSpecification bool `json:"with_specification,omitempty" yaml:"with_specification,omitempty"`
}

Service service

swagger:model Service

func (*Service) ContextValidate 

func (m *Service) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service based on context it is used

func (*Service) MarshalBinary 

func (m *Service) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Service) UnmarshalBinary 

func (m *Service) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Service) Validate 

func (m *Service) Validate(formats strfmt.Registry) error

Validate validates this service

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.