Struct VerificationFlow 

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

VerificationFlow : 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/self-service/flows/verify-email-account-activation

Fields

active: Option<String>

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

expires_at: Option<String>

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.

id: String

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

issued_at: Option<String>

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

request_url: Option<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. verify your email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the verification challenge was passed.

transient_payload: Option<Value>

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

type: String

The flow type can either be api or browser.

ui: Box<UiContainer>

Implementations

impl VerificationFlow

pub fn new( id: String, state: Option<Value>, type: String, ui: UiContainer, ) -> VerificationFlow

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/self-service/flows/verify-email-account-activation

Trait Implementations

impl Clone for VerificationFlow

fn clone(&self) -> VerificationFlow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationFlow

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

Formats the value using the given formatter.

impl Default for VerificationFlow

fn default() -> VerificationFlow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VerificationFlow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VerificationFlow

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

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 VerificationFlow