Documentation ¶
Index ¶
- type CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload
- func (m *CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) MarshalBinary() ([]byte, error)
- func (m *CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) UnmarshalBinary(b []byte) error
- func (m *CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload) Validate(formats strfmt.Registry) error
- type CredentialsType
- type Error
- type ErrorContainer
- type Form
- type FormField
- type FormFields
- type GenericError
- type GenericErrorPayload
- type HealthNotReadyStatus
- type HealthStatus
- type Identity
- type LoginRequest
- type LoginRequestMethod
- type LoginRequestMethodConfig
- type RegistrationRequest
- type RegistrationRequestMethod
- type RegistrationRequestMethodConfig
- type RequestMethodConfig
- type Session
- type SettingsRequest
- type SettingsRequestMethod
- type Traits
- type UUID
- type VerifiableAddress
- type VerifiableAddressType
- type VerificationRequest
- type Version
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
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 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
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"` // Errors contains all form errors. These will be duplicates of the individual field errors. Errors []*Error `json:"errors"` // fields // Required: true Fields FormFields `json:"fields"` // 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 ¶
MarshalBinary interface implementation
func (*Form) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FormField ¶
type FormField struct { // Disabled is the equivalent of `<input disabled="{{.Disabled}}">` Disabled bool `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}}">` // 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: true Required *bool `json:"required"` // 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 ¶
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,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
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 { // addresses Addresses []*VerifiableAddress `json:"addresses"` // 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. // Required: true TraitsSchemaID *string `json:"traits_schema_id"` // 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. // 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"` // 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
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
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"` // Errors contains all form errors. These will be duplicates of the individual field errors. Errors []*Error `json:"errors"` // fields // Required: true Fields FormFields `json:"fields"` // 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
type RegistrationRequest ¶
type RegistrationRequest struct { // active // Required: true Active CredentialsType `json:"active"` // 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"` // 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
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 { // Action should be used as the form action URL `<form action="{{ .Action }}" method="post">`. // Required: true Action *string `json:"action"` // Errors contains all form errors. These will be duplicates of the individual field errors. Errors []*Error `json:"errors"` // fields // Required: true Fields FormFields `json:"fields"` // 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
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"` // Errors contains all form errors. These will be duplicates of the individual field errors. Errors []*Error `json:"errors"` // fields // Required: true Fields FormFields `json:"fields"` // 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
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 ¶
MarshalBinary interface implementation
func (*Session) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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"` // 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"` // UpdateSuccessful, if true, indicates that the settings request has been updated successfully with the provided data. // Done will stay true when repeatedly checking. If set to true, done will revert back to false only // when a request with invalid (e.g. "please use a valid phone number") data was sent. // Required: true UpdateSuccessful *bool `json:"update_successful"` }
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.
For more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/user-settings-profile-management
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
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
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
type VerifiableAddressType ¶
type VerifiableAddressType string
VerifiableAddressType verifiable address type
swagger:model VerifiableAddressType
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"` // 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
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_settings_strategy_profile_flow_payload.go
- credentials_type.go
- error.go
- error_container.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
- registration_request.go
- registration_request_method.go
- registration_request_method_config.go
- request_method_config.go
- session.go
- settings_request.go
- settings_request_method.go
- traits.go
- uuid.go
- verifiable_address.go
- verifiable_address_type.go
- verification_request.go
- version.go