Documentation
¶
Index ¶
- type CompleteSelfServiceBrowserProfileManagementFlowPayload
- type CredentialsType
- type Error
- type Form
- type FormField
- type FormFields
- type GenericError
- type GenericErrorPayload
- type HealthNotReadyStatus
- type HealthStatus
- type Identity
- type LoginRequest
- type LoginRequestMethod
- type LoginRequestMethodConfig
- func (m *LoginRequestMethodConfig) MarshalBinary() ([]byte, error)
- func (m LoginRequestMethodConfig) MarshalJSON() ([]byte, error)
- func (m *LoginRequestMethodConfig) UnmarshalBinary(b []byte) error
- func (m *LoginRequestMethodConfig) UnmarshalJSON(raw []byte) error
- func (m *LoginRequestMethodConfig) Validate(formats strfmt.Registry) error
- type LoginRequestMethodConfigAllOf0
- type LoginRequestMethodConfigAllOf1
- type LoginRequestMethodConfigAllOf2
- type LoginRequestMethodConfigAllOf3
- type ProfileManagementRequest
- type RegistrationRequest
- type RegistrationRequestMethod
- type RegistrationRequestMethodConfig
- func (m *RegistrationRequestMethodConfig) MarshalBinary() ([]byte, error)
- func (m RegistrationRequestMethodConfig) MarshalJSON() ([]byte, error)
- func (m *RegistrationRequestMethodConfig) UnmarshalBinary(b []byte) error
- func (m *RegistrationRequestMethodConfig) UnmarshalJSON(raw []byte) error
- func (m *RegistrationRequestMethodConfig) Validate(formats strfmt.Registry) error
- type RegistrationRequestMethodConfigAllOf0
- type RegistrationRequestMethodConfigAllOf1
- type RegistrationRequestMethodConfigAllOf2
- type RegistrationRequestMethodConfigAllOf3
- type RegistrationRequestMethodConfigAllOf4
- type RegistrationRequestMethodConfigAllOf5
- type Session
- type Traits
- type UUID
- type Version
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
type CredentialsType ¶
type CredentialsType string
CredentialsType CredentialsType represents several different credential types, like password credentials, passwordless credentials,
and so on. swagger:model CredentialsType
type Error ¶
type Error struct {
// Code FormErrorCode `json:"id,omitempty"`
Message string `json:"message,omitempty"`
}
Error error swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Form ¶
type Form struct {
// Action should be used as the form action URL (<form action="{{ .Action }}" method="post">).
Action string `json:"action,omitempty"`
// Errors contains all form errors. These will be duplicates of the individual field errors.
Errors []*Error `json:"errors"`
// fields
Fields FormFields `json:"fields,omitempty"`
// Method is the form method (e.g. POST)
Method string `json:"method,omitempty"`
}
Form HTMLForm represents a HTML Form. The container can work with both HTTP Form and JSON requests swagger:model form
func (*Form) MarshalBinary ¶
MarshalBinary interface implementation
func (*Form) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FormField ¶
type FormField struct {
// Disabled is the equivalent of <input disabled="{{.Disabled}}">
Disabled string `json:"disabled,omitempty"`
// Errors contains all validation errors this particular field has caused.
Errors []*Error `json:"errors"`
// Name is the equivalent of <input name="{{.Name}}">
Name string `json:"name,omitempty"`
// 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}}">
Type string `json:"type,omitempty"`
// Value is the equivalent of <input value="{{.Value}}">
Value interface{} `json:"value,omitempty"`
}
FormField Field represents a HTML Form Field swagger:model formField
func (*FormField) MarshalBinary ¶
MarshalBinary interface implementation
func (*FormField) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FormFields ¶
type FormFields []*FormField
FormFields Fields contains multiple fields swagger:model formFields
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
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 []map[string]interface{} `json:"details"`
// 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 nolint:deadcode,unused 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
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
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
type Identity ¶
type Identity struct {
// id
// Required: true
// Format: uuid4
ID UUID `json:"id"`
// traits
// Required: true
Traits Traits `json:"traits"`
// TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
TraitsSchemaID string `json:"traits_schema_id,omitempty"`
// TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.
//
// format: url
TraitsSchemaURL string `json:"traits_schema_url,omitempty"`
}
Identity identity swagger:model Identity
func (*Identity) MarshalBinary ¶
MarshalBinary interface implementation
func (*Identity) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LoginRequest ¶
type LoginRequest struct {
// active
Active CredentialsType `json:"active,omitempty"`
// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in,
// a new request has to be initiated.
// Format: date-time
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
// id
// Format: uuid4
ID UUID `json:"id,omitempty"`
// IssuedAt is the time (UTC) when the request occurred.
// Format: date-time
IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`
// Methods contains context for all enabled login methods. If a login request has been
// processed, but for example the password is incorrect, this will contain error messages.
Methods map[string]LoginRequestMethod `json:"methods,omitempty"`
// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
// to forward information contained in the URL's path or query for example.
RequestURL string `json:"request_url,omitempty"`
}
LoginRequest login request swagger:model loginRequest
func (*LoginRequest) MarshalBinary ¶
func (m *LoginRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginRequest) UnmarshalBinary ¶
func (m *LoginRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LoginRequestMethod ¶
type LoginRequestMethod struct {
// config
Config *LoginRequestMethodConfig `json:"config,omitempty"`
// method
Method CredentialsType `json:"method,omitempty"`
}
LoginRequestMethod login request method swagger:model loginRequestMethod
func (*LoginRequestMethod) MarshalBinary ¶
func (m *LoginRequestMethod) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginRequestMethod) UnmarshalBinary ¶
func (m *LoginRequestMethod) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LoginRequestMethodConfig ¶
type LoginRequestMethodConfig struct {
LoginRequestMethodConfigAllOf0
LoginRequestMethodConfigAllOf1
LoginRequestMethodConfigAllOf2
LoginRequestMethodConfigAllOf3
}
LoginRequestMethodConfig login request method config swagger:model loginRequestMethodConfig
func (*LoginRequestMethodConfig) MarshalBinary ¶
func (m *LoginRequestMethodConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (LoginRequestMethodConfig) MarshalJSON ¶
func (m LoginRequestMethodConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*LoginRequestMethodConfig) UnmarshalBinary ¶
func (m *LoginRequestMethodConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*LoginRequestMethodConfig) UnmarshalJSON ¶
func (m *LoginRequestMethodConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type LoginRequestMethodConfigAllOf0 ¶
type LoginRequestMethodConfigAllOf0 interface{}
LoginRequestMethodConfigAllOf0 login request method config all of0 swagger:model LoginRequestMethodConfigAllOf0
type LoginRequestMethodConfigAllOf1 ¶
type LoginRequestMethodConfigAllOf1 interface{}
LoginRequestMethodConfigAllOf1 login request method config all of1 swagger:model LoginRequestMethodConfigAllOf1
type LoginRequestMethodConfigAllOf2 ¶
type LoginRequestMethodConfigAllOf2 interface{}
LoginRequestMethodConfigAllOf2 login request method config all of2 swagger:model LoginRequestMethodConfigAllOf2
type LoginRequestMethodConfigAllOf3 ¶
type LoginRequestMethodConfigAllOf3 interface{}
LoginRequestMethodConfigAllOf3 login request method config all of3 swagger:model LoginRequestMethodConfigAllOf3
type ProfileManagementRequest ¶
type ProfileManagementRequest struct {
// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile,
// a new request has to be initiated.
// Format: date-time
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
// form
Form *Form `json:"form,omitempty"`
// id
// Format: uuid4
ID UUID `json:"id,omitempty"`
// identity
Identity *Identity `json:"identity,omitempty"`
// IssuedAt is the time (UTC) when the request occurred.
// Format: date-time
IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`
// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
// to forward information contained in the URL's path or query for example.
RequestURL string `json:"request_url,omitempty"`
// UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data.
// Done will stay true when repeatedly checking. If set to true, done will revert back to false only
// when a request with invalid (e.g. "please use a valid phone number") data was sent.
UpdateSuccessful bool `json:"update_successful,omitempty"`
}
ProfileManagementRequest Request presents a profile management request
This request is used when an identity wants to update profile information (especially traits) in a selfservice manner.
For more information head over to: https://www.ory.sh/docs/kratos/selfservice/profile swagger:model profileManagementRequest
func (*ProfileManagementRequest) MarshalBinary ¶
func (m *ProfileManagementRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProfileManagementRequest) UnmarshalBinary ¶
func (m *ProfileManagementRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RegistrationRequest ¶
type RegistrationRequest struct {
// active
Active CredentialsType `json:"active,omitempty"`
// ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in,
// a new request has to be initiated.
// Format: date-time
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
// id
// Format: uuid4
ID UUID `json:"id,omitempty"`
// IssuedAt is the time (UTC) when the request occurred.
// Format: date-time
IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`
// Methods contains context for all enabled registration methods. If a registration request has been
// processed, but for example the password is incorrect, this will contain error messages.
Methods map[string]RegistrationRequestMethod `json:"methods,omitempty"`
// RequestURL is the initial URL that was requested from ORY Kratos. It can be used
// to forward information contained in the URL's path or query for example.
RequestURL string `json:"request_url,omitempty"`
}
RegistrationRequest registration request swagger:model registrationRequest
func (*RegistrationRequest) MarshalBinary ¶
func (m *RegistrationRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegistrationRequest) UnmarshalBinary ¶
func (m *RegistrationRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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
type RegistrationRequestMethodConfig ¶
type RegistrationRequestMethodConfig struct {
RegistrationRequestMethodConfigAllOf0
RegistrationRequestMethodConfigAllOf1
RegistrationRequestMethodConfigAllOf2
RegistrationRequestMethodConfigAllOf3
RegistrationRequestMethodConfigAllOf4
RegistrationRequestMethodConfigAllOf5
}
RegistrationRequestMethodConfig registration request method config swagger:model registrationRequestMethodConfig
func (*RegistrationRequestMethodConfig) MarshalBinary ¶
func (m *RegistrationRequestMethodConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (RegistrationRequestMethodConfig) MarshalJSON ¶
func (m RegistrationRequestMethodConfig) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*RegistrationRequestMethodConfig) UnmarshalBinary ¶
func (m *RegistrationRequestMethodConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*RegistrationRequestMethodConfig) UnmarshalJSON ¶
func (m *RegistrationRequestMethodConfig) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type RegistrationRequestMethodConfigAllOf0 ¶
type RegistrationRequestMethodConfigAllOf0 interface{}
RegistrationRequestMethodConfigAllOf0 registration request method config all of0 swagger:model RegistrationRequestMethodConfigAllOf0
type RegistrationRequestMethodConfigAllOf1 ¶
type RegistrationRequestMethodConfigAllOf1 interface{}
RegistrationRequestMethodConfigAllOf1 registration request method config all of1 swagger:model RegistrationRequestMethodConfigAllOf1
type RegistrationRequestMethodConfigAllOf2 ¶
type RegistrationRequestMethodConfigAllOf2 interface{}
RegistrationRequestMethodConfigAllOf2 registration request method config all of2 swagger:model RegistrationRequestMethodConfigAllOf2
type RegistrationRequestMethodConfigAllOf3 ¶
type RegistrationRequestMethodConfigAllOf3 interface{}
RegistrationRequestMethodConfigAllOf3 registration request method config all of3 swagger:model RegistrationRequestMethodConfigAllOf3
type RegistrationRequestMethodConfigAllOf4 ¶
type RegistrationRequestMethodConfigAllOf4 interface{}
RegistrationRequestMethodConfigAllOf4 registration request method config all of4 swagger:model RegistrationRequestMethodConfigAllOf4
type RegistrationRequestMethodConfigAllOf5 ¶
type RegistrationRequestMethodConfigAllOf5 interface{}
RegistrationRequestMethodConfigAllOf5 registration request method config all of5 swagger:model RegistrationRequestMethodConfigAllOf5
type Session ¶
type Session struct {
// authenticated at
// Format: date-time
AuthenticatedAt strfmt.DateTime `json:"authenticated_at,omitempty"`
// expires at
// Format: date-time
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
// identity
Identity *Identity `json:"identity,omitempty"`
// issued at
// Format: date-time
IssuedAt strfmt.DateTime `json:"issued_at,omitempty"`
// sid
// Format: uuid4
Sid UUID `json:"sid,omitempty"`
}
Session session swagger:model session
func (*Session) MarshalBinary ¶
MarshalBinary interface implementation
func (*Session) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Version ¶
type Version struct {
// Version is the service's version.
Version string `json:"version,omitempty"`
}
Version version swagger:model version
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
¶
- complete_self_service_browser_profile_management_flow_payload.go
- credentials_type.go
- error.go
- form.go
- form_field.go
- form_fields.go
- generic_error.go
- generic_error_payload.go
- health_not_ready_status.go
- health_status.go
- identity.go
- login_request.go
- login_request_method.go
- login_request_method_config.go
- profile_management_request.go
- registration_request.go
- registration_request_method.go
- registration_request_method_config.go
- session.go
- traits.go
- uuid.go
- version.go