models

package
v0.6.2-alpha.1 Latest Latest
Warning

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

 Go to latest Published: May 14, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CompleteSelfServiceBrowserProfileManagementFlowPayload 

type CompleteSelfServiceBrowserProfileManagementFlowPayload struct {

	// Traits contains all of the identity's traits.
	//
	// type: string
	// format: binary
	// Required: true
	Traits interface{} `json:"traits"`
}

CompleteSelfServiceBrowserProfileManagementFlowPayload complete self service browser profile management flow payload swagger:model completeSelfServiceBrowserProfileManagementFlowPayload

func (*CompleteSelfServiceBrowserProfileManagementFlowPayload) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceBrowserProfileManagementFlowPayload) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceBrowserProfileManagementFlowPayload) Validate 

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

Validate validates this complete self service browser profile management flow payload

type CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload 

type CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload struct {

	// RequestID is request ID.
	//
	// in: query
	RequestID string `json:"request_id,omitempty"`

	// Traits contains all of the identity's traits.
	//
	// type: string
	// format: binary
	// Required: true
	Traits interface{} `json:"traits"`
}

CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload complete self service browser settings strategy profile flow payload

swagger:model completeSelfServiceBrowserSettingsStrategyProfileFlowPayload

func (*CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) Validate 

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

Validate validates this complete self service browser settings strategy profile flow payload

type CompleteSelfServiceLoginFlowWithPasswordMethod 

type CompleteSelfServiceLoginFlowWithPasswordMethod struct {

	// Sending the anti-csrf token is only required for browser login flows.
	CsrfToken string `json:"csrf_token,omitempty"`

	// Identifier is the email or username of the user trying to log in.
	Identifier string `json:"identifier,omitempty"`

	// The user's password.
	Password string `json:"password,omitempty"`
}

CompleteSelfServiceLoginFlowWithPasswordMethod complete self service login flow with password method

swagger:model CompleteSelfServiceLoginFlowWithPasswordMethod

func (*CompleteSelfServiceLoginFlowWithPasswordMethod) ContextValidate 

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

ContextValidate validates this complete self service login flow with password method based on context it is used

func (*CompleteSelfServiceLoginFlowWithPasswordMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceLoginFlowWithPasswordMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceLoginFlowWithPasswordMethod) Validate 

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

Validate validates this complete self service login flow with password method

type CompleteSelfServiceRecoveryFlowWithLinkMethod 

type CompleteSelfServiceRecoveryFlowWithLinkMethod struct {

	// Sending the anti-csrf token is only required for browser login flows.
	CsrfToken string `json:"csrf_token,omitempty"`

	// Email to Recover
	//
	// Needs to be set when initiating the flow. If the email is a registered
	// recovery email, a recovery link will be sent. If the email is not known,
	// a email with details on what happened will be sent instead.
	//
	// format: email
	// in: body
	Email string `json:"email,omitempty"`
}

CompleteSelfServiceRecoveryFlowWithLinkMethod complete self service recovery flow with link method

swagger:model completeSelfServiceRecoveryFlowWithLinkMethod

func (*CompleteSelfServiceRecoveryFlowWithLinkMethod) ContextValidate 

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

ContextValidate validates this complete self service recovery flow with link method based on context it is used

func (*CompleteSelfServiceRecoveryFlowWithLinkMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceRecoveryFlowWithLinkMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceRecoveryFlowWithLinkMethod) Validate 

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

Validate validates this complete self service recovery flow with link method

type CompleteSelfServiceSettingsFlowWithPasswordMethod 

type CompleteSelfServiceSettingsFlowWithPasswordMethod struct {

	// CSRFToken is the anti-CSRF token
	//
	// type: string
	CsrfToken string `json:"csrf_token,omitempty"`

	// Password is the updated password
	//
	// type: string
	// Required: true
	Password *string `json:"password"`
}

CompleteSelfServiceSettingsFlowWithPasswordMethod complete self service settings flow with password method

swagger:model CompleteSelfServiceSettingsFlowWithPasswordMethod

func (*CompleteSelfServiceSettingsFlowWithPasswordMethod) ContextValidate 

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

ContextValidate validates this complete self service settings flow with password method based on context it is used

func (*CompleteSelfServiceSettingsFlowWithPasswordMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceSettingsFlowWithPasswordMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceSettingsFlowWithPasswordMethod) Validate 

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

Validate validates this complete self service settings flow with password method

type CompleteSelfServiceVerificationFlowWithLinkMethod 

type CompleteSelfServiceVerificationFlowWithLinkMethod struct {

	// Sending the anti-csrf token is only required for browser login flows.
	CsrfToken string `json:"csrf_token,omitempty"`

	// Email to Verify
	//
	// Needs to be set when initiating the flow. If the email is a registered
	// verification email, a verification link will be sent. If the email is not known,
	// a email with details on what happened will be sent instead.
	//
	// format: email
	// in: body
	Email string `json:"email,omitempty"`
}

CompleteSelfServiceVerificationFlowWithLinkMethod complete self service verification flow with link method

swagger:model completeSelfServiceVerificationFlowWithLinkMethod

func (*CompleteSelfServiceVerificationFlowWithLinkMethod) ContextValidate 

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

ContextValidate validates this complete self service verification flow with link method based on context it is used

func (*CompleteSelfServiceVerificationFlowWithLinkMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*CompleteSelfServiceVerificationFlowWithLinkMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CompleteSelfServiceVerificationFlowWithLinkMethod) Validate 

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

Validate validates this complete self service verification flow with link method

type CreateIdentity 

type CreateIdentity struct {

	// SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
	// Required: true
	SchemaID *string `json:"schema_id"`

	// Traits represent an identity's traits. The identity is able to create, modify, and delete traits
	// in a self-service manner. The input will always be validated against the JSON Schema defined
	// in `schema_url`.
	// Required: true
	Traits interface{} `json:"traits"`
}

CreateIdentity create identity

swagger:model CreateIdentity

func (*CreateIdentity) ContextValidate 

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

ContextValidate validates this create identity based on context it is used

func (*CreateIdentity) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateIdentity) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateIdentity) Validate 

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

Validate validates this create identity 

type CreateRecoveryLink struct {

	// Link Expires In
	//
	// The recovery link will expire at that point in time. Defaults to the configuration value of
	// `selfservice.flows.recovery.request_lifespan`.
	// Pattern: ^[0-9]+(ns|us|ms|s|m|h)$
	ExpiresIn string `json:"expires_in,omitempty"`

	// identity id
	// Required: true
	// Format: uuid4
	IdentityID *UUID `json:"identity_id"`
}

CreateRecoveryLink create recovery link

swagger:model CreateRecoveryLink

func (*CreateRecoveryLink) ContextValidate 

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

ContextValidate validate this create recovery link based on the context it is used

func (*CreateRecoveryLink) MarshalBinary 

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

MarshalBinary interface implementation

func (*CreateRecoveryLink) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*CreateRecoveryLink) Validate 

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

Validate validates this create recovery link

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) ContextValidate 

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

ContextValidate validates this credentials type based on context it is used

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 ErrorContainer 

type ErrorContainer struct {

	// Errors in the container
	// Required: true
	Errors interface{} `json:"errors"`

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

ErrorContainer error container

swagger:model errorContainer

func (*ErrorContainer) ContextValidate 

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

ContextValidate validate this error container based on the context it is used

func (*ErrorContainer) MarshalBinary 

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

MarshalBinary interface implementation

func (*ErrorContainer) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ErrorContainer) Validate 

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

Validate validates this error container

type Errors 

type Errors []*Error

Errors errors swagger:model Errors

func (Errors) Validate 

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

Validate validates this errors

type Form 

type Form struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`
}

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 {

	// Disabled is the equivalent of `<input {{if .Disabled}}disabled{{end}}">`
	Disabled bool `json:"disabled,omitempty"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Name is the equivalent of `<input name="{{.Name}}">`
	// Required: true
	Name *string `json:"name"`

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

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

	// Type is the equivalent of `<input type="{{.Type}}">`
	// Required: true
	Type *string `json:"type"`

	// 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) ContextValidate 

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

ContextValidate validate this form field based on the context it is used

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 []*FormField

FormFields Fields contains multiple fields

swagger:model formFields

func (FormFields) ContextValidate 

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

ContextValidate validate this form fields based on the context it is used

func (FormFields) Validate 

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

Validate validates this form fields

type GenericError 

type GenericError struct {

	// error
	Error *GenericErrorPayload `json:"error,omitempty"`
}

GenericError Error response

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

swagger:model genericError

func (*GenericError) ContextValidate 

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

ContextValidate validate this generic error based on the context it is used

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 GenericErrorPayload 

type GenericErrorPayload struct {

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

	// Debug contains debug information. This is usually not available and has to be enabled.
	// Example: The database adapter was unable to find the element
	Debug string `json:"debug,omitempty"`

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

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

GenericErrorPayload generic error payload

swagger:model genericErrorPayload

func (*GenericErrorPayload) ContextValidate 

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

ContextValidate validates this generic error payload based on context it is used

func (*GenericErrorPayload) MarshalBinary 

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

MarshalBinary interface implementation

func (*GenericErrorPayload) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*GenericErrorPayload) Validate 

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

Validate validates this generic error payload

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) ContextValidate 

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

ContextValidate validates this health not ready status based on context it is used

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) ContextValidate 

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

ContextValidate validates this health status based on context it is used

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 ID 

type ID int64

ID ID

swagger:model ID

func (ID) ContextValidate 

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

ContextValidate validates this ID based on context it is used

func (ID) Validate 

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

Validate validates this ID

type Identity 

type Identity struct {

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

	// RecoveryAddresses contains all the addresses that can be used to recover an identity.
	RecoveryAddresses []*RecoveryAddress `json:"recovery_addresses,omitempty"`

	// SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
	// Required: true
	SchemaID *string `json:"schema_id"`

	// SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.
	//
	// format: url
	// Required: true
	SchemaURL *string `json:"schema_url"`

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

	// VerifiableAddresses contains all the addresses that can be verified by the user.
	VerifiableAddresses []*VerifiableAddress `json:"verifiable_addresses,omitempty"`
}

Identity identity

swagger:model Identity

func (*Identity) ContextValidate 

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

ContextValidate validate this identity based on the context it is used

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 LoginFlow 

type LoginFlow struct {

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

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

	// Forced stores whether this login flow should enforce re-authentication.
	Forced bool `json:"forced,omitempty"`

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

	// IssuedAt is the time (UTC) when the flow started.
	// Required: true
	// Format: date-time
	IssuedAt *strfmt.DateTime `json:"issued_at"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// List of login methods
	//
	// This is the list of available login methods with their required form fields, such as `identifier` and `password`
	// for the password login method. This will also contain error messages such as "password can not be empty".
	// Required: true
	Methods map[string]LoginFlowMethod `json:"methods"`

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

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

LoginFlow Login Flow

This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client.

Once a login flow is completed successfully, a session cookie or session token will be issued.

swagger:model loginFlow

func (*LoginFlow) ContextValidate 

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

ContextValidate validate this login flow based on the context it is used

func (*LoginFlow) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginFlow) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginFlow) Validate 

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

Validate validates this login flow

type LoginFlowMethod 

type LoginFlowMethod struct {

	// config
	// Required: true
	Config *LoginFlowMethodConfig `json:"config"`

	// method
	// Required: true
	Method *CredentialsType `json:"method"`
}

LoginFlowMethod login flow method

swagger:model loginFlowMethod

func (*LoginFlowMethod) ContextValidate 

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

ContextValidate validate this login flow method based on the context it is used

func (*LoginFlowMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginFlowMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginFlowMethod) Validate 

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

Validate validates this login flow method

type LoginFlowMethodConfig 

type LoginFlowMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`

	// Providers is set for the "oidc" flow method.
	Providers []*FormField `json:"providers"`
}

LoginFlowMethodConfig login flow method config

swagger:model loginFlowMethodConfig

func (*LoginFlowMethodConfig) ContextValidate 

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

ContextValidate validate this login flow method config based on the context it is used

func (*LoginFlowMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginFlowMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginFlowMethodConfig) Validate 

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

Validate validates this login flow method config

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.
	// Required: true
	// Format: date-time
	ExpiresAt *strfmt.DateTime `json:"expires_at"`

	// Forced stores whether this login request should enforce reauthentication.
	Forced bool `json:"forced,omitempty"`

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

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

	// messages
	Messages Messages `json:"messages,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.
	// Required: true
	Methods map[string]LoginRequestMethod `json:"methods"`

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`
}

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
	// Required: true
	Config *LoginRequestMethodConfig `json:"config"`

	// method
	// Required: true
	Method CredentialsType `json:"method"`
}

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 {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`

	// Providers is set for the "oidc" request method.
	Providers []*FormField `json:"providers"`
}

LoginRequestMethodConfig login request method config

swagger:model loginRequestMethodConfig

func (*LoginRequestMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginRequestMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginRequestMethodConfig) Validate 

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

Validate validates this login request method config

type LoginViaAPIResponse 

type LoginViaAPIResponse struct {

	// session
	// Required: true
	Session *Session `json:"session"`

	// The Session Token
	//
	// A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization
	// Header:
	//
	// Authorization: bearer ${session-token}
	//
	// The session token is only issued for API flows, not for Browser flows!
	// Required: true
	SessionToken *string `json:"session_token"`
}

LoginViaAPIResponse The Response for Login Flows via API

swagger:model loginViaApiResponse

func (*LoginViaAPIResponse) ContextValidate 

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

ContextValidate validate this login via Api response based on the context it is used

func (*LoginViaAPIResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*LoginViaAPIResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*LoginViaAPIResponse) Validate 

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

Validate validates this login via Api response

type Message 

type Message struct {

	// context
	Context interface{} `json:"context,omitempty"`

	// id
	ID ID `json:"id,omitempty"`

	// text
	Text string `json:"text,omitempty"`

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

Message message

swagger:model Message

func (*Message) ContextValidate 

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

ContextValidate validate this message based on the context it is used

func (*Message) MarshalBinary 

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

MarshalBinary interface implementation

func (*Message) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Message) Validate 

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

Validate validates this message

type Messages 

type Messages []*Message

Messages messages

swagger:model Messages

func (Messages) ContextValidate 

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

ContextValidate validate this messages based on the context it is used

func (Messages) Validate 

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

Validate validates this messages

type NullTime 

type NullTime strfmt.DateTime

NullTime NullTime implements sql.NullTime functionality.

swagger:model NullTime

func (NullTime) ContextValidate 

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

ContextValidate validates this null time based on context it is used

func (*NullTime) MarshalBinary 

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

MarshalBinary interface implementation

func (NullTime) MarshalJSON 

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

MarshalJSON retrieves a NullTime value as JSON output

func (*NullTime) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*NullTime) UnmarshalJSON 

func (m *NullTime) UnmarshalJSON(b []byte) error

UnmarshalJSON sets a NullTime value from JSON input

func (NullTime) Validate 

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

Validate validates this null time

type OidcStrategyCredentialsConfig 

type OidcStrategyCredentialsConfig struct {

	// provider
	Provider string `json:"provider,omitempty"`

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

OidcStrategyCredentialsConfig oidc strategy credentials config swagger:model oidcStrategyCredentialsConfig

func (*OidcStrategyCredentialsConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*OidcStrategyCredentialsConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*OidcStrategyCredentialsConfig) Validate 

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

Validate validates this oidc strategy credentials config

type OidcStrategyRequestMethod 

type OidcStrategyRequestMethod 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"`

	// providers
	Providers []*FormField `json:"providers"`
}

OidcStrategyRequestMethod oidc strategy request method swagger:model oidcStrategyRequestMethod

func (*OidcStrategyRequestMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*OidcStrategyRequestMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*OidcStrategyRequestMethod) Validate 

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

Validate validates this oidc strategy request method

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.
	// Required: true
	// Format: date-time
	ExpiresAt *strfmt.DateTime `json:"expires_at"`

	// form
	// Required: true
	Form *Form `json:"form"`

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

	// identity
	// Required: true
	Identity *Identity `json:"identity"`

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

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

	// 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.
	// Required: true
	UpdateSuccessful *bool `json:"update_successful"`
}

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 ProviderCredentialsConfig 

type ProviderCredentialsConfig struct {

	// provider
	Provider string `json:"provider,omitempty"`

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

ProviderCredentialsConfig provider credentials config

swagger:model ProviderCredentialsConfig

func (*ProviderCredentialsConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*ProviderCredentialsConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProviderCredentialsConfig) Validate 

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

Validate validates this provider credentials config

type RWMutex 

type RWMutex interface{}

RWMutex A RWMutex is a reader/writer mutual exclusion lock. The lock can be held by an arbitrary number of readers or a single writer. The zero value for a RWMutex is an unlocked mutex.

A RWMutex must not be copied after first use.

If a goroutine holds a RWMutex for reading and another goroutine might call Lock, no goroutine should expect to be able to acquire a read lock until the initial read lock is released. In particular, this prohibits recursive read locking. This is to ensure that the lock eventually becomes available; a blocked Lock call excludes new readers from acquiring the lock. swagger:model RWMutex

type RecoveryAddress 

type RecoveryAddress struct {

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

	// value
	// Required: true
	Value *string `json:"value"`

	// via
	// Required: true
	Via *RecoveryAddressType `json:"via"`
}

RecoveryAddress recovery address

swagger:model RecoveryAddress

func (*RecoveryAddress) ContextValidate 

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

ContextValidate validate this recovery address based on the context it is used

func (*RecoveryAddress) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryAddress) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryAddress) Validate 

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

Validate validates this recovery address

type RecoveryAddressType 

type RecoveryAddressType string

RecoveryAddressType recovery address type

swagger:model RecoveryAddressType

func (RecoveryAddressType) ContextValidate 

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

ContextValidate validates this recovery address type based on context it is used

func (RecoveryAddressType) Validate 

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

Validate validates this recovery address type

type RecoveryFlow 

type RecoveryFlow struct {

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active string `json:"active,omitempty"`

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

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

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

	// messages
	Messages Messages `json:"messages,omitempty"`

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

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

	// state
	// Required: true
	State *State `json:"state"`

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

RecoveryFlow A Recovery Flow

This request is used when an identity wants to recover their account.

We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)

swagger:model recoveryFlow

func (*RecoveryFlow) ContextValidate 

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

ContextValidate validate this recovery flow based on the context it is used

func (*RecoveryFlow) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryFlow) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryFlow) Validate 

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

Validate validates this recovery flow

type RecoveryFlowMethod 

type RecoveryFlowMethod struct {

	// config
	// Required: true
	Config *RecoveryFlowMethodConfig `json:"config"`

	// Method contains the request credentials type.
	// Required: true
	Method *string `json:"method"`
}

RecoveryFlowMethod recovery flow method

swagger:model recoveryFlowMethod

func (*RecoveryFlowMethod) ContextValidate 

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

ContextValidate validate this recovery flow method based on the context it is used

func (*RecoveryFlowMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryFlowMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryFlowMethod) Validate 

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

Validate validates this recovery flow method

type RecoveryFlowMethodConfig 

type RecoveryFlowMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`
}

RecoveryFlowMethodConfig recovery flow method config

swagger:model recoveryFlowMethodConfig

func (*RecoveryFlowMethodConfig) ContextValidate 

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

ContextValidate validate this recovery flow method config based on the context it is used

func (*RecoveryFlowMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryFlowMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryFlowMethodConfig) Validate 

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

Validate validates this recovery flow method config 

type RecoveryLink struct {

	// Recovery Link Expires At
	//
	// The timestamp when the recovery link expires.
	// Format: date-time
	ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`

	// Recovery Link
	//
	// This link can be used to recover the account.
	// Required: true
	RecoveryLink *string `json:"recovery_link"`
}

RecoveryLink recovery link

swagger:model recoveryLink

func (*RecoveryLink) ContextValidate 

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

ContextValidate validates this recovery link based on context it is used

func (*RecoveryLink) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryLink) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryLink) Validate 

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

Validate validates this recovery link

type RecoveryRequest 

type RecoveryRequest struct {

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active string `json:"active,omitempty"`

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

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

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

	// messages
	Messages Messages `json:"messages,omitempty"`

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

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

	// state
	// Required: true
	State State `json:"state"`
}

RecoveryRequest Request presents a recovery request

This request is used when an identity wants to recover their account.

We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)

swagger:model recoveryRequest

func (*RecoveryRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryRequest) Validate 

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

Validate validates this recovery request

type RecoveryRequestMethod 

type RecoveryRequestMethod struct {

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

	// Method contains the request credentials type.
	Method string `json:"method,omitempty"`
}

RecoveryRequestMethod recovery request method

swagger:model recoveryRequestMethod

func (*RecoveryRequestMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*RecoveryRequestMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RecoveryRequestMethod) Validate 

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

Validate validates this recovery request method

type RegistrationFlow 

type RegistrationFlow struct {

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

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

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

	// IssuedAt is the time (UTC) when the flow occurred.
	// Required: true
	// Format: date-time
	IssuedAt *strfmt.DateTime `json:"issued_at"`

	// messages
	Messages Messages `json:"messages,omitempty"`

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

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

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

RegistrationFlow registration flow

swagger:model registrationFlow

func (*RegistrationFlow) ContextValidate 

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

ContextValidate validate this registration flow based on the context it is used

func (*RegistrationFlow) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationFlow) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationFlow) Validate 

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

Validate validates this registration flow

type RegistrationFlowMethod 

type RegistrationFlowMethod struct {

	// config
	// Required: true
	Config *RegistrationFlowMethodConfig `json:"config"`

	// method
	// Required: true
	Method *CredentialsType `json:"method"`
}

RegistrationFlowMethod registration flow method

swagger:model registrationFlowMethod

func (*RegistrationFlowMethod) ContextValidate 

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

ContextValidate validate this registration flow method based on the context it is used

func (*RegistrationFlowMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationFlowMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationFlowMethod) Validate 

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

Validate validates this registration flow method

type RegistrationFlowMethodConfig 

type RegistrationFlowMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`

	// Providers is set for the "oidc" registration method.
	Providers []*FormField `json:"providers"`
}

RegistrationFlowMethodConfig registration flow method config

swagger:model registrationFlowMethodConfig

func (*RegistrationFlowMethodConfig) ContextValidate 

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

ContextValidate validate this registration flow method config based on the context it is used

func (*RegistrationFlowMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationFlowMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationFlowMethodConfig) Validate 

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

Validate validates this registration flow method config

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.
	// Required: true
	// Format: date-time
	ExpiresAt *strfmt.DateTime `json:"expires_at"`

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

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

	// messages
	Messages Messages `json:"messages,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.
	// Required: true
	Methods map[string]RegistrationRequestMethod `json:"methods"`

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`
}

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 {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`

	// Providers is set for the "oidc" request method.
	Providers []*FormField `json:"providers"`
}

RegistrationRequestMethodConfig registration request method config

swagger:model registrationRequestMethodConfig

func (*RegistrationRequestMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationRequestMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationRequestMethodConfig) Validate 

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

Validate validates this registration request method config

type RegistrationViaAPIResponse 

type RegistrationViaAPIResponse struct {

	// identity
	// Required: true
	Identity *Identity `json:"identity"`

	// session
	Session *Session `json:"session,omitempty"`

	// The Session Token
	//
	// This field is only set when the session hook is configured as a post-registration hook.
	//
	// A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization
	// Header:
	//
	// Authorization: bearer ${session-token}
	//
	// The session token is only issued for API flows, not for Browser flows!
	// Required: true
	SessionToken *string `json:"session_token"`
}

RegistrationViaAPIResponse The Response for Registration Flows via API

swagger:model registrationViaApiResponse

func (*RegistrationViaAPIResponse) ContextValidate 

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

ContextValidate validate this registration via Api response based on the context it is used

func (*RegistrationViaAPIResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*RegistrationViaAPIResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RegistrationViaAPIResponse) Validate 

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

Validate validates this registration via Api response

type RequestMethodConfig 

type RequestMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`
}

RequestMethodConfig request method config

swagger:model RequestMethodConfig

func (*RequestMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*RequestMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RequestMethodConfig) Validate 

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

Validate validates this request method config

type RequestMethodConfigurator 

type RequestMethodConfigurator interface{}

RequestMethodConfigurator request method configurator swagger:model RequestMethodConfigurator

type RevokeSession 

type RevokeSession struct {

	// The Session Token
	//
	// Invalidate this session token.
	// Required: true
	SessionToken *string `json:"session_token"`
}

RevokeSession revoke session

swagger:model revokeSession

func (*RevokeSession) ContextValidate 

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

ContextValidate validates this revoke session based on context it is used

func (*RevokeSession) MarshalBinary 

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

MarshalBinary interface implementation

func (*RevokeSession) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RevokeSession) Validate 

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

Validate validates this revoke session

type Session 

type Session struct {

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

	// authenticated at
	// Required: true
	// Format: date-time
	AuthenticatedAt *strfmt.DateTime `json:"authenticated_at"`

	// expires at
	// Required: true
	// Format: date-time
	ExpiresAt *strfmt.DateTime `json:"expires_at"`

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

	// identity
	// Required: true
	Identity *Identity `json:"identity"`

	// issued at
	// Required: true
	// Format: date-time
	IssuedAt *strfmt.DateTime `json:"issued_at"`
}

Session session

swagger:model session

func (*Session) ContextValidate 

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

ContextValidate validate this session based on the context it is used

func (*Session) MarshalBinary 

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

MarshalBinary interface implementation

func (*Session) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Session) Validate 

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

Validate validates this session

type SettingsFlow 

type SettingsFlow struct {

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active string `json:"active,omitempty"`

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

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

	// identity
	// Required: true
	Identity *Identity `json:"identity"`

	// IssuedAt is the time (UTC) when the flow occurred.
	// Required: true
	// Format: date-time
	IssuedAt *strfmt.DateTime `json:"issued_at"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Methods contains context for all enabled registration methods. If a settings flow has been
	// processed, but for example the first name is empty, this will contain error messages.
	// Required: true
	Methods map[string]SettingsFlowMethod `json:"methods"`

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

	// state
	// Required: true
	State *State `json:"state"`

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

SettingsFlow Flow represents a Settings Flow

This flow is used when an identity wants to update settings (e.g. profile data, passwords, ...) in a selfservice manner.

We recommend reading the [User Settings Documentation](../self-service/flows/user-settings)

swagger:model settingsFlow

func (*SettingsFlow) ContextValidate 

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

ContextValidate validate this settings flow based on the context it is used

func (*SettingsFlow) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsFlow) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsFlow) Validate 

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

Validate validates this settings flow

type SettingsFlowMethod 

type SettingsFlowMethod struct {

	// config
	// Required: true
	Config *SettingsFlowMethodConfig `json:"config"`

	// Method is the name of this flow method.
	// Required: true
	Method *string `json:"method"`
}

SettingsFlowMethod settings flow method

swagger:model settingsFlowMethod

func (*SettingsFlowMethod) ContextValidate 

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

ContextValidate validate this settings flow method based on the context it is used

func (*SettingsFlowMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsFlowMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsFlowMethod) Validate 

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

Validate validates this settings flow method

type SettingsFlowMethodConfig 

type SettingsFlowMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`
}

SettingsFlowMethodConfig settings flow method config

swagger:model settingsFlowMethodConfig

func (*SettingsFlowMethodConfig) ContextValidate 

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

ContextValidate validate this settings flow method config based on the context it is used

func (*SettingsFlowMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsFlowMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsFlowMethodConfig) Validate 

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

Validate validates this settings flow method config

type SettingsRequest 

type SettingsRequest struct {

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active string `json:"active,omitempty"`

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

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

	// identity
	// Required: true
	Identity *Identity `json:"identity"`

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

	// messages
	Messages Messages `json:"messages,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.
	// Required: true
	Methods map[string]SettingsRequestMethod `json:"methods"`

	// 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.
	// Required: true
	RequestURL *string `json:"request_url"`

	// state
	// Required: true
	State State `json:"state"`
}

SettingsRequest Request presents a settings request

This request is used when an identity wants to update settings (e.g. profile data, passwords, ...) in a selfservice manner.

We recommend reading the [User Settings Documentation](../self-service/flows/user-settings)

swagger:model settingsRequest

func (*SettingsRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsRequest) Validate 

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

Validate validates this settings request

type SettingsRequestMethod 

type SettingsRequestMethod struct {

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

	// Method contains the request credentials type.
	Method string `json:"method,omitempty"`
}

SettingsRequestMethod settings request method

swagger:model settingsRequestMethod

func (*SettingsRequestMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsRequestMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsRequestMethod) Validate 

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

Validate validates this settings request method

type SettingsViaAPIResponse 

type SettingsViaAPIResponse struct {

	// flow
	// Required: true
	Flow *SettingsFlow `json:"flow"`

	// identity
	// Required: true
	Identity *Identity `json:"identity"`
}

SettingsViaAPIResponse The Response for Settings Flows via API

swagger:model settingsViaApiResponse

func (*SettingsViaAPIResponse) ContextValidate 

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

ContextValidate validate this settings via Api response based on the context it is used

func (*SettingsViaAPIResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*SettingsViaAPIResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*SettingsViaAPIResponse) Validate 

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

Validate validates this settings via Api response

type State 

type State string

State state

swagger:model State

func (State) ContextValidate 

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

ContextValidate validates this state based on context it is used

func (State) Validate 

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

Validate validates this state

type Traits 

type Traits interface{}

Traits traits

swagger:model Traits

type Type 

type Type string

Type Type is the flow type.

The flow type can either be `api` or `browser`.

swagger:model Type

func (Type) ContextValidate 

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

ContextValidate validates this type based on context it is used

func (Type) Validate 

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

Validate validates this type

type UUID 

type UUID strfmt.UUID4

UUID UUID

swagger:model UUID

func (UUID) ContextValidate 

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

ContextValidate validates this UUID based on context it is used

func (UUID) Validate 

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

Validate validates this UUID

type UpdateIdentity 

type UpdateIdentity struct {

	// SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set
	// will update the Identity's SchemaID.
	SchemaID string `json:"schema_id,omitempty"`

	// Traits represent an identity's traits. The identity is able to create, modify, and delete traits
	// in a self-service manner. The input will always be validated against the JSON Schema defined
	// in `schema_id`.
	// Required: true
	Traits interface{} `json:"traits"`
}

UpdateIdentity update identity

swagger:model UpdateIdentity

func (*UpdateIdentity) ContextValidate 

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

ContextValidate validates this update identity based on context it is used

func (*UpdateIdentity) MarshalBinary 

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

MarshalBinary interface implementation

func (*UpdateIdentity) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*UpdateIdentity) Validate 

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

Validate validates this update identity

type VerifiableAddress 

type VerifiableAddress struct {

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

	// status
	// Required: true
	Status *VerifiableAddressStatus `json:"status"`

	// value
	// Required: true
	Value *string `json:"value"`

	// verified
	// Required: true
	Verified *bool `json:"verified"`

	// verified at
	// Format: date-time
	VerifiedAt NullTime `json:"verified_at,omitempty"`

	// via
	// Required: true
	Via *VerifiableAddressType `json:"via"`
}

VerifiableAddress verifiable address

swagger:model VerifiableAddress

func (*VerifiableAddress) ContextValidate 

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

ContextValidate validate this verifiable address based on the context it is used

func (*VerifiableAddress) MarshalBinary 

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

MarshalBinary interface implementation

func (*VerifiableAddress) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*VerifiableAddress) Validate 

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

Validate validates this verifiable address

type VerifiableAddressStatus 

type VerifiableAddressStatus string

VerifiableAddressStatus verifiable address status

swagger:model VerifiableAddressStatus

func (VerifiableAddressStatus) ContextValidate 

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

ContextValidate validates this verifiable address status based on context it is used

func (VerifiableAddressStatus) Validate 

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

Validate validates this verifiable address status

type VerifiableAddressType 

type VerifiableAddressType string

VerifiableAddressType verifiable address type

swagger:model VerifiableAddressType

func (VerifiableAddressType) ContextValidate 

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

ContextValidate validates this verifiable address type based on context it is used

func (VerifiableAddressType) Validate 

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

Validate validates this verifiable address type

type VerificationFlow 

type VerificationFlow struct {

	// Active, if set, contains the registration method that is being used. It is initially
	// not set.
	Active string `json:"active,omitempty"`

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,
	// 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"`

	// messages
	Messages Messages `json:"messages,omitempty"`

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

	// 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"`

	// state
	// Required: true
	State *State `json:"state"`

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

VerificationFlow A Verification Flow

Used to verify an out-of-band communication channel such as an email address or a phone number.

For more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation

swagger:model verificationFlow

func (*VerificationFlow) ContextValidate 

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

ContextValidate validate this verification flow based on the context it is used

func (*VerificationFlow) MarshalBinary 

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

MarshalBinary interface implementation

func (*VerificationFlow) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*VerificationFlow) Validate 

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

Validate validates this verification flow

type VerificationFlowMethod 

type VerificationFlowMethod struct {

	// config
	// Required: true
	Config *VerificationFlowMethodConfig `json:"config"`

	// Method contains the request credentials type.
	// Required: true
	Method *string `json:"method"`
}

VerificationFlowMethod verification flow method

swagger:model verificationFlowMethod

func (*VerificationFlowMethod) ContextValidate 

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

ContextValidate validate this verification flow method based on the context it is used

func (*VerificationFlowMethod) MarshalBinary 

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

MarshalBinary interface implementation

func (*VerificationFlowMethod) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*VerificationFlowMethod) Validate 

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

Validate validates this verification flow method

type VerificationFlowMethodConfig 

type VerificationFlowMethodConfig struct {

	// Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`.
	// Required: true
	Action *string `json:"action"`

	// fields
	// Required: true
	Fields FormFields `json:"fields"`

	// messages
	Messages Messages `json:"messages,omitempty"`

	// Method is the form method (e.g. POST)
	// Required: true
	Method *string `json:"method"`
}

VerificationFlowMethodConfig verification flow method config

swagger:model verificationFlowMethodConfig

func (*VerificationFlowMethodConfig) ContextValidate 

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

ContextValidate validate this verification flow method config based on the context it is used

func (*VerificationFlowMethodConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*VerificationFlowMethodConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*VerificationFlowMethodConfig) Validate 

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

Validate validates this verification flow method config

type VerificationRequest 

type VerificationRequest struct {

	// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,
	// 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"`

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

	// messages
	Messages Messages `json:"messages,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"`

	// Success, if true, implies that the request was completed successfully.
	Success bool `json:"success,omitempty"`

	// via
	Via VerifiableAddressType `json:"via,omitempty"`
}

VerificationRequest Request presents a verification request

This request is used when an identity wants to verify an out-of-band communication channel such as an email address or a phone number.

For more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation

swagger:model verificationRequest

func (*VerificationRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*VerificationRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*VerificationRequest) Validate 

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

Validate validates this verification request

type Version 

type Version struct {

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

Version version

swagger:model version

func (*Version) ContextValidate 

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

ContextValidate validates this version based on context it is used

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.