Struct ory_client::models::login_flow::LoginFlow

pub struct LoginFlow {

    pub active: Option<IdentityCredentialsType>,
    pub created_at: Option<String>,
    pub expires_at: String,
    pub id: String,
    pub issued_at: String,
    pub oauth2_login_challenge: Option<String>,
    pub oauth2_login_request: Option<Box<OAuth2LoginRequest>>,
    pub refresh: Option<bool>,
    pub request_url: String,
    pub requested_aal: Option<AuthenticatorAssuranceLevel>,
    pub return_to: Option<String>,
    pub session_token_exchange_code: Option<String>,
    pub state: Option<Value>,
    pub _type: String,
    pub ui: Box<UiContainer>,
    pub updated_at: Option<String>,
}

LoginFlow : This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client. Once a login flow is completed successfully, a session cookie or session token will be issued.

Fields

active: Option<IdentityCredentialsType>

created_at: Option<String>

CreatedAt is a helper struct field for gobuffalo.pop.

expires_at: String

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

id: String

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

issued_at: String

IssuedAt is the time (UTC) when the flow started.

oauth2_login_challenge: Option<String>

Ory OAuth 2.0 Login Challenge. This value is set using the login_challenge query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.

oauth2_login_request: Option<Box<OAuth2LoginRequest>>

refresh: Option<bool>

Refresh stores whether this login flow should enforce re-authentication.

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.

requested_aal: Option<AuthenticatorAssuranceLevel>

return_to: Option<String>

ReturnTo contains the requested return_to URL.

session_token_exchange_code: Option<String>

SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type "api", and only on creating the login flow.

state: Option<Value>

State represents the state of this request: choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed.

_type: String

The flow type can either be api or browser.

ui: Box<UiContainer>

updated_at: Option<String>

UpdatedAt is a helper struct field for gobuffalo.pop.

Implementations

impl LoginFlow

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

This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client. Once a login flow is completed successfully, a session cookie or session token will be issued.

Trait Implementations

impl Clone for LoginFlow

fn clone(&self) -> LoginFlow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoginFlow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginFlow

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<LoginFlow> for LoginFlow

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

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 LoginFlow