Struct ory_client::models::settings_flow::SettingsFlow

pub struct SettingsFlow {
    pub active: Option<String>,
    pub continue_with: Option<Vec<ContinueWith>>,
    pub expires_at: String,
    pub id: String,
    pub identity: Box<Identity>,
    pub issued_at: String,
    pub request_url: String,
    pub return_to: Option<String>,
    pub state: Option<Value>,
    pub _type: String,
    pub ui: Box<UiContainer>,
}

SettingsFlow : This flow is used when an identity wants to update settings (e.g. profile data, passwords, …) in a selfservice manner. We recommend reading the User Settings Documentation

Fields

active: Option<String>

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

continue_with: Option<Vec<ContinueWith>>

Contains a list of actions, that could follow this flow It can, for example, contain a reference to the verification flow, created as part of the user’s registration.

expires_at: String

ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting, a new flow has to be initiated.

id: String

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

identity: Box<Identity>

issued_at: String

IssuedAt is the time (UTC) when the flow 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 flow. It knows two states: show_form: No user data has been collected, or it is invalid, and thus the form should be shown. success: Indicates that the settings flow 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 flow with invalid (e.g. "please use a valid phone number") data was sent.

_type: String

The flow type can either be api or browser.

ui: Box<UiContainer>

Implementations

impl SettingsFlow

pub fn new( expires_at: String, id: String, identity: Identity, issued_at: String, request_url: String, state: Option<Value>, _type: String, ui: UiContainer ) -> SettingsFlow

This flow is used when an identity wants to update settings (e.g. profile data, passwords, …) in a selfservice manner. We recommend reading the User Settings Documentation

Trait Implementations

impl Clone for SettingsFlow

fn clone(&self) -> SettingsFlow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsFlow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SettingsFlow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<SettingsFlow> for SettingsFlow

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SettingsFlow

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 SettingsFlow