Struct RegistrationFlow 

pub struct RegistrationFlow {

    pub active: Option<ActiveEnum>,
    pub expires_at: String,
    pub id: String,
    pub identity_schema: Option<String>,
    pub issued_at: String,
    pub oauth2_login_challenge: Option<String>,
    pub oauth2_login_request: Option<Box<OAuth2LoginRequest>>,
    pub organization_id: Option<Option<String>>,
    pub request_url: String,
    pub return_to: Option<String>,
    pub session_token_exchange_code: Option<String>,
    pub state: Option<Value>,
    pub transient_payload: Option<Value>,
    pub type: String,
    pub ui: Box<UiContainer>,
}

Fields

active: Option<ActiveEnum>

Active, if set, contains the registration method that is being used. It is initially not set. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode

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 registration flow, this represents the id in the registration ui’s query parameter: http://<selfservice.flows.registration.ui_url>/?flow=

identity_schema: Option<String>

IdentitySchema optionally holds the ID of the identity schema that is used for this flow. This value can be set by the user when creating the flow and should be retained when the flow is saved or converted to another flow.

issued_at: String

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

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>>

organization_id: Option<Option<String>>

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.

session_token_exchange_code: Option<String>

SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the 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 flow.

state: Option<Value>

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

transient_payload: Option<Value>

TransientPayload is used to pass data from the registration to a webhook

type: String

The flow type can either be api or browser.

ui: Box<UiContainer>

Implementations

impl RegistrationFlow

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

Trait Implementations

impl Clone for RegistrationFlow

fn clone(&self) -> RegistrationFlow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegistrationFlow

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

Formats the value using the given formatter.

impl Default for RegistrationFlow

fn default() -> RegistrationFlow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegistrationFlow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RegistrationFlow

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

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 RegistrationFlow