models

package
v0.4.2-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 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 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 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 ErrorContainer 

type ErrorContainer struct {

	// errors
	Errors interface{} `json:"errors,omitempty"`

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

ErrorContainer error container

swagger:model errorContainer

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 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) 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) 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) 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, ...).
	Code int64 `json:"code,omitempty"`

	// Debug contains debug information. This is usually not available and has to be enabled.
	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) 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) 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 ID 

type ID int64

ID ID

swagger:model ID

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

	// 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
	SchemaURL string `json:"schema_url,omitempty"`

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

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

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.
	// 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 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) 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) Validate 

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

Validate validates this messages

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

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

Validate validates this recovery address type

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 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 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 Session 

type Session struct {

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

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

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

	// sid
	// Required: true
	// Format: uuid4
	Sid UUID `json:"sid"`
}

Session session

swagger:model session

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 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 State 

type State string

State state

swagger:model State

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

swagger:model Type

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

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

Validate validates this UUID

type VerifiableAddress 

type VerifiableAddress struct {

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

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

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

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

	// verified at
	// Format: date-time
	VerifiedAt strfmt.DateTime `json:"verified_at,omitempty"`

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

VerifiableAddress verifiable address

swagger:model VerifiableAddress

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 VerifiableAddressType 

type VerifiableAddressType string

VerifiableAddressType verifiable address type

swagger:model VerifiableAddressType

func (VerifiableAddressType) Validate 

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

Validate validates this verifiable address type

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