Struct UpdateRecoveryFlowWithCodeMethod 

pub struct UpdateRecoveryFlowWithCodeMethod {
    pub code: Option<String>,
    pub csrf_token: Option<String>,
    pub email: Option<String>,
    pub method: MethodEnum,
    pub recovery_address: Option<String>,
    pub recovery_confirm_address: Option<String>,
    pub recovery_select_address: Option<String>,
    pub screen: Option<String>,
    pub transient_payload: Option<Value>,
}

UpdateRecoveryFlowWithCodeMethod : Update Recovery Flow with Code Method

Fields

code: Option<String>

Code from the recovery email If you want to submit a code, use this field, but make sure to not include the email field, as well.

csrf_token: Option<String>

Sending the anti-csrf token is only required for browser login flows.

email: Option<String>

The email address of the account to recover If the email belongs to a valid account, a recovery email will be sent. If you want to notify the email address if the account does not exist, see the notify_unknown_recipients flag If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code. format: email

method: MethodEnum

Method is the method that should be used for this recovery flow Allowed values are link and code. link RecoveryStrategyLink code RecoveryStrategyCode

recovery_address: Option<String>

A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2.

recovery_confirm_address: Option<String>

If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2.

recovery_select_address: Option<String>

If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are ‘masked’ (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2.

screen: Option<String>

Set to "previous" to go back in the flow, meaningfully. Used in RecoveryV2.

transient_payload: Option<Value>

Transient data to pass along to any webhooks

Implementations

impl UpdateRecoveryFlowWithCodeMethod

pub fn new(method: MethodEnum) -> UpdateRecoveryFlowWithCodeMethod

Update Recovery Flow with Code Method

Trait Implementations

impl Clone for UpdateRecoveryFlowWithCodeMethod

fn clone(&self) -> UpdateRecoveryFlowWithCodeMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRecoveryFlowWithCodeMethod

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

Formats the value using the given formatter.

impl Default for UpdateRecoveryFlowWithCodeMethod

fn default() -> UpdateRecoveryFlowWithCodeMethod

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpdateRecoveryFlowWithCodeMethod

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateRecoveryFlowWithCodeMethod

fn eq(&self, other: &UpdateRecoveryFlowWithCodeMethod) -> 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 UpdateRecoveryFlowWithCodeMethod

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 UpdateRecoveryFlowWithCodeMethod