models

package
v0.0.1-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CredentialsType 

type CredentialsType string

CredentialsType CredentialsType represents several different credential types, like password credentials, passwordless credentials,

and so on. swagger:model CredentialsType

func (CredentialsType) Validate 

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

Validate validates this credentials type

type Error 

type Error struct {

	// Code    FormErrorCode `json:"id,omitempty"`
	Message string `json:"message,omitempty"`
}

Error error swagger:model Error

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 Form 

type Form struct {

	// Action should be used as the form action URL (<form action="{{ .Action }}" method="post">).
	Action string `json:"action,omitempty"`

	// Errors contains all form errors. These will be duplicates of the individual field errors.
	Errors []*Error `json:"errors"`

	// fields
	Fields FormFields `json:"fields,omitempty"`

	// Method is the form method (e.g. POST)
	Method string `json:"method,omitempty"`
}

Form HTMLForm represents a HTML Form. The container can work with both HTTP Form and JSON requests swagger:model form

func (*Form) MarshalBinary 

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

MarshalBinary interface implementation

func (*Form) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Form) Validate 

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

Validate validates this form

type FormField 

type FormField struct {

	// Errors contains all validation errors this particular field has caused.
	Errors []*Error `json:"errors"`

	// Name is the equivalent of <input name="{{.Name}}">
	Name string `json:"name,omitempty"`

	// Required is the equivalent of <input required="{{.Required}}">
	Required bool `json:"required,omitempty"`

	// Type is the equivalent of <input type="{{.Type}}">
	Type string `json:"type,omitempty"`

	// Value is the equivalent of <input value="{{.Value}}">
	Value interface{} `json:"value,omitempty"`
}

FormField Field represents a HTML Form Field swagger:model formField

func (*FormField) MarshalBinary 

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

MarshalBinary interface implementation

func (*FormField) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*FormField) Validate 

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

Validate validates this form field

type FormFields 

type FormFields map[string]FormField

FormFields Fields contains multiple fields swagger:model formFields

func (FormFields) Validate 

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

Validate validates this form fields

type GenericError 

type GenericError struct {

	// Name is the error name.
	// Required: true
	Error *string `json:"error"`

	// Code represents the error status code (404, 403, 401, ...).
	ErrorCode int64 `json:"error_code,omitempty"`

	// Debug contains debug information. This is usually not available and has to be enabled.
	ErrorDebug string `json:"error_debug,omitempty"`

	// Hint contains further information on the nature of the error.
	ErrorHint string `json:"error_hint,omitempty"`
}

GenericError Error response

Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred. swagger:model genericError

func (*GenericError) MarshalBinary 

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

MarshalBinary interface implementation

func (*GenericError) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GenericError) Validate 

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

Validate validates this generic error

type HealthNotReadyStatus 

type HealthNotReadyStatus struct {

	// Errors contains a list of errors that caused the not ready status.
	Errors map[string]string `json:"errors,omitempty"`
}

HealthNotReadyStatus health not ready status swagger:model healthNotReadyStatus

func (*HealthNotReadyStatus) MarshalBinary 

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

MarshalBinary interface implementation

func (*HealthNotReadyStatus) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HealthNotReadyStatus) Validate 

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

Validate validates this health not ready status

type HealthStatus 

type HealthStatus struct {

	// Status always contains "ok".
	Status string `json:"status,omitempty"`
}

HealthStatus health status swagger:model healthStatus

func (*HealthStatus) MarshalBinary 

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

MarshalBinary interface implementation

func (*HealthStatus) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*HealthStatus) Validate 

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

Validate validates this health status

type Identity 

type Identity struct {

	// id
	// Required: true
	// Format: uuid4
	ID UUID `json:"id"`

	// traits
	// Required: true
	Traits Traits `json:"traits"`

	// TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
	TraitsSchemaID string `json:"traits_schema_id,omitempty"`

	// TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.
	//
	// format: url
	TraitsSchemaURL string `json:"traits_schema_url,omitempty"`
}

Identity identity swagger:model Identity

func (*Identity) MarshalBinary 

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

MarshalBinary interface implementation

func (*Identity) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Identity) Validate 

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

Validate validates this identity

type LoginRequest 

type LoginRequest struct {

	// active
	Active CredentialsType `json:"active,omitempty"`

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in,
	// a new request has to be initiated.
	// Format: date-time
	ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`

	// id
	// Format: uuid4
	ID UUID `json:"id,omitempty"`

	// IssuedAt is the time (UTC) when the request occurred.
	// Format: date-time
	IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`

	// Methods contains context for all enabled login methods. If a login request has been
	// processed, but for example the password is incorrect, this will contain error messages.
	Methods map[string]LoginRequestMethod `json:"methods,omitempty"`

	// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
	// to forward information contained in the URL's path or query for example.
	RequestURL string `json:"request_url,omitempty"`
}

LoginRequest login request swagger:model loginRequest

func (*LoginRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginRequest) Validate 

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

Validate validates this login request

type LoginRequestMethod 

type LoginRequestMethod struct {

	// config
	Config *LoginRequestMethodConfig `json:"config,omitempty"`

	// method
	Method CredentialsType `json:"method,omitempty"`
}

LoginRequestMethod login request method swagger:model loginRequestMethod

func (*LoginRequestMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginRequestMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginRequestMethod) Validate 

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

Validate validates this login request method

type LoginRequestMethodConfig 

type LoginRequestMethodConfig struct {
	LoginRequestMethodConfigAllOf0

	LoginRequestMethodConfigAllOf1

	LoginRequestMethodConfigAllOf2

	LoginRequestMethodConfigAllOf3
}

LoginRequestMethodConfig login request method config swagger:model loginRequestMethodConfig

func (*LoginRequestMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (LoginRequestMethodConfig) MarshalJSON 

func (m LoginRequestMethodConfig) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*LoginRequestMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginRequestMethodConfig) UnmarshalJSON 

func (m *LoginRequestMethodConfig) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*LoginRequestMethodConfig) Validate 

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

Validate validates this login request method config

type LoginRequestMethodConfigAllOf0 

type LoginRequestMethodConfigAllOf0 interface{}

LoginRequestMethodConfigAllOf0 login request method config all of0 swagger:model LoginRequestMethodConfigAllOf0

type LoginRequestMethodConfigAllOf1 

type LoginRequestMethodConfigAllOf1 interface{}

LoginRequestMethodConfigAllOf1 login request method config all of1 swagger:model LoginRequestMethodConfigAllOf1

type LoginRequestMethodConfigAllOf2 

type LoginRequestMethodConfigAllOf2 interface{}

LoginRequestMethodConfigAllOf2 login request method config all of2 swagger:model LoginRequestMethodConfigAllOf2

type LoginRequestMethodConfigAllOf3 

type LoginRequestMethodConfigAllOf3 interface{}

LoginRequestMethodConfigAllOf3 login request method config all of3 swagger:model LoginRequestMethodConfigAllOf3

type ProfileManagementRequest 

type ProfileManagementRequest struct {

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile,
	// a new request has to be initiated.
	// Format: date-time
	ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`

	// form
	Form *Form `json:"form,omitempty"`

	// id
	// Format: uuid4
	ID UUID `json:"id,omitempty"`

	// identity
	Identity *Identity `json:"identity,omitempty"`

	// IssuedAt is the time (UTC) when the request occurred.
	// Format: date-time
	IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`

	// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
	// to forward information contained in the URL's path or query for example.
	RequestURL string `json:"request_url,omitempty"`

	// UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data.
	// Done will stay true when repeatedly checking. If set to true, done will revert back to false only
	// when a request with invalid (e.g. "please use a valid phone number") data was sent.
	UpdateSuccessful bool `json:"update_successful,omitempty"`
}

ProfileManagementRequest Request presents a profile management request

This request is used when an identity wants to update profile information (especially traits) in a selfservice manner.

For more information head over to: https://www.ory.sh/docs/kratos/selfservice/profile swagger:model profileManagementRequest

func (*ProfileManagementRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*ProfileManagementRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProfileManagementRequest) Validate 

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

Validate validates this profile management request

type RegistrationRequest 

type RegistrationRequest struct {

	// active
	Active CredentialsType `json:"active,omitempty"`

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in,
	// a new request has to be initiated.
	// Format: date-time
	ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`

	// id
	// Format: uuid4
	ID UUID `json:"id,omitempty"`

	// IssuedAt is the time (UTC) when the request occurred.
	// Format: date-time
	IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`

	// Methods contains context for all enabled registration methods. If a registration request has been
	// processed, but for example the password is incorrect, this will contain error messages.
	Methods map[string]RegistrationRequestMethod `json:"methods,omitempty"`

	// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
	// to forward information contained in the URL's path or query for example.
	RequestURL string `json:"request_url,omitempty"`
}

RegistrationRequest registration request swagger:model registrationRequest

func (*RegistrationRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationRequest) Validate 

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

Validate validates this registration request

type RegistrationRequestMethod 

type RegistrationRequestMethod struct {

	// config
	Config *RegistrationRequestMethodConfig `json:"config,omitempty"`

	// method
	Method CredentialsType `json:"method,omitempty"`
}

RegistrationRequestMethod registration request method swagger:model registrationRequestMethod

func (*RegistrationRequestMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationRequestMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationRequestMethod) Validate 

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

Validate validates this registration request method

type RegistrationRequestMethodConfig 

type RegistrationRequestMethodConfig struct {
	RegistrationRequestMethodConfigAllOf0

	RegistrationRequestMethodConfigAllOf1

	RegistrationRequestMethodConfigAllOf2

	RegistrationRequestMethodConfigAllOf3

	RegistrationRequestMethodConfigAllOf4
}

RegistrationRequestMethodConfig registration request method config swagger:model registrationRequestMethodConfig

func (*RegistrationRequestMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (RegistrationRequestMethodConfig) MarshalJSON 

func (m RegistrationRequestMethodConfig) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*RegistrationRequestMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationRequestMethodConfig) UnmarshalJSON 

func (m *RegistrationRequestMethodConfig) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*RegistrationRequestMethodConfig) Validate 

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

Validate validates this registration request method config

type RegistrationRequestMethodConfigAllOf0 

type RegistrationRequestMethodConfigAllOf0 interface{}

RegistrationRequestMethodConfigAllOf0 registration request method config all of0 swagger:model RegistrationRequestMethodConfigAllOf0

type RegistrationRequestMethodConfigAllOf1 

type RegistrationRequestMethodConfigAllOf1 interface{}

RegistrationRequestMethodConfigAllOf1 registration request method config all of1 swagger:model RegistrationRequestMethodConfigAllOf1

type RegistrationRequestMethodConfigAllOf2 

type RegistrationRequestMethodConfigAllOf2 interface{}

RegistrationRequestMethodConfigAllOf2 registration request method config all of2 swagger:model RegistrationRequestMethodConfigAllOf2

type RegistrationRequestMethodConfigAllOf3 

type RegistrationRequestMethodConfigAllOf3 interface{}

RegistrationRequestMethodConfigAllOf3 registration request method config all of3 swagger:model RegistrationRequestMethodConfigAllOf3

type RegistrationRequestMethodConfigAllOf4 

type RegistrationRequestMethodConfigAllOf4 interface{}

RegistrationRequestMethodConfigAllOf4 registration request method config all of4 swagger:model RegistrationRequestMethodConfigAllOf4

type Traits 

type Traits interface{}

Traits traits swagger:model Traits

type UUID 

type UUID strfmt.UUID4

UUID UUID swagger:model UUID

func (UUID) Validate 

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

Validate validates this UUID

type Version 

type Version struct {

	// Version is the service's version.
	Version string `json:"version,omitempty"`
}

Version version swagger:model version

func (*Version) MarshalBinary 

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

MarshalBinary interface implementation

func (*Version) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Version) Validate 

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

Validate validates this version

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.