models

package
v0.5.4-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 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 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) 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) 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) 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) 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) 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) 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) Validate 

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

Validate validates this credentials type

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) 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 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,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) 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) 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) 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) 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 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) 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) 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 NullTime 

type NullTime strfmt.DateTime

NullTime NullTime implements sql.NullTime functionality.

swagger:model NullTime

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