Struct RecoveryFlow 

pub struct RecoveryFlow {
    pub active: Option<String>,
    pub continue_with: Option<Vec<ContinueWith>>,
    pub expires_at: String,
    pub id: String,
    pub issued_at: String,
    pub request_url: String,
    pub return_to: Option<String>,
    pub state: Option<Value>,
    pub transient_payload: Option<Value>,
    pub type: String,
    pub ui: Box<UiContainer>,
}

RecoveryFlow : This request is used when an identity wants to recover their account. We recommend reading the Account Recovery Documentation

Fields

active: Option<String>

Active, if set, contains the recovery method that is being used. It is initially not set.

continue_with: Option<Vec<ContinueWith>>

Contains possible actions that could follow this flow

expires_at: String

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.

id: String

ID represents the request’s unique ID. When performing the recovery flow, this represents the id in the recovery ui’s query parameter: http://<selfservice.flows.recovery.ui_url>?request=

issued_at: String

IssuedAt is the time (UTC) when the request occurred.

request_url: String

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.

return_to: Option<String>

ReturnTo contains the requested return_to URL.

state: Option<Value>

State represents the state of this request: choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed.

transient_payload: Option<Value>

TransientPayload is used to pass data from the recovery flow to hooks and email templates

type: String

The flow type can either be api or browser.

ui: Box<UiContainer>

Implementations

impl RecoveryFlow

pub fn new( expires_at: String, id: String, issued_at: String, request_url: String, state: Option<Value>, type: String, ui: UiContainer, ) -> RecoveryFlow

This request is used when an identity wants to recover their account. We recommend reading the Account Recovery Documentation

Trait Implementations

impl Clone for RecoveryFlow

fn clone(&self) -> RecoveryFlow

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecoveryFlow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RecoveryFlow

fn default() -> RecoveryFlow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RecoveryFlow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RecoveryFlow

fn eq(&self, other: &RecoveryFlow) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RecoveryFlow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RecoveryFlow