ory_client/models/login_flow.rs
1/*
2 * Ory APIs
3 *
4 * # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
5 *
6 * The version of the OpenAPI document: v1.22.2
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// 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.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct LoginFlow {
17 /// The active login method If set contains the login method used. If the flow is new, it is unset. 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
18 #[serde(rename = "active", skip_serializing_if = "Option::is_none")]
19 pub active: Option<ActiveEnum>,
20 /// CreatedAt is a helper struct field for gobuffalo.pop.
21 #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")]
22 pub created_at: Option<String>,
23 /// ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.
24 #[serde(rename = "expires_at")]
25 pub expires_at: String,
26 /// 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>
27 #[serde(rename = "id")]
28 pub id: String,
29 /// 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.
30 #[serde(rename = "identity_schema", skip_serializing_if = "Option::is_none")]
31 pub identity_schema: Option<String>,
32 /// IssuedAt is the time (UTC) when the flow started.
33 #[serde(rename = "issued_at")]
34 pub issued_at: String,
35 /// 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.
36 #[serde(rename = "oauth2_login_challenge", skip_serializing_if = "Option::is_none")]
37 pub oauth2_login_challenge: Option<String>,
38 #[serde(rename = "oauth2_login_request", skip_serializing_if = "Option::is_none")]
39 pub oauth2_login_request: Option<Box<models::OAuth2LoginRequest>>,
40 #[serde(rename = "organization_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
41 pub organization_id: Option<Option<String>>,
42 /// Refresh stores whether this login flow should enforce re-authentication.
43 #[serde(rename = "refresh", skip_serializing_if = "Option::is_none")]
44 pub refresh: Option<bool>,
45 /// 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.
46 #[serde(rename = "request_url")]
47 pub request_url: String,
48 #[serde(rename = "requested_aal", skip_serializing_if = "Option::is_none")]
49 pub requested_aal: Option<models::AuthenticatorAssuranceLevel>,
50 /// ReturnTo contains the requested return_to URL.
51 #[serde(rename = "return_to", skip_serializing_if = "Option::is_none")]
52 pub return_to: Option<String>,
53 /// 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.
54 #[serde(rename = "session_token_exchange_code", skip_serializing_if = "Option::is_none")]
55 pub session_token_exchange_code: Option<String>,
56 /// 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.
57 #[serde(rename = "state", deserialize_with = "Option::deserialize")]
58 pub state: Option<serde_json::Value>,
59 /// TransientPayload is used to pass data from the login to hooks and email templates
60 #[serde(rename = "transient_payload", skip_serializing_if = "Option::is_none")]
61 pub transient_payload: Option<serde_json::Value>,
62 /// The flow type can either be `api` or `browser`.
63 #[serde(rename = "type")]
64 pub r#type: String,
65 #[serde(rename = "ui")]
66 pub ui: Box<models::UiContainer>,
67 /// UpdatedAt is a helper struct field for gobuffalo.pop.
68 #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")]
69 pub updated_at: Option<String>,
70}
71
72impl LoginFlow {
73 /// 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.
74 pub fn new(expires_at: String, id: String, issued_at: String, request_url: String, state: Option<serde_json::Value>, r#type: String, ui: models::UiContainer) -> LoginFlow {
75 LoginFlow {
76 active: None,
77 created_at: None,
78 expires_at,
79 id,
80 identity_schema: None,
81 issued_at,
82 oauth2_login_challenge: None,
83 oauth2_login_request: None,
84 organization_id: None,
85 refresh: None,
86 request_url,
87 requested_aal: None,
88 return_to: None,
89 session_token_exchange_code: None,
90 state,
91 transient_payload: None,
92 r#type,
93 ui: Box::new(ui),
94 updated_at: None,
95 }
96 }
97}
98/// The active login method If set contains the login method used. If the flow is new, it is unset. 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
99#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
100pub enum ActiveEnum {
101 #[serde(rename = "password")]
102 Password,
103 #[serde(rename = "oidc")]
104 Oidc,
105 #[serde(rename = "totp")]
106 Totp,
107 #[serde(rename = "lookup_secret")]
108 LookupSecret,
109 #[serde(rename = "webauthn")]
110 Webauthn,
111 #[serde(rename = "code")]
112 Code,
113 #[serde(rename = "passkey")]
114 Passkey,
115 #[serde(rename = "profile")]
116 Profile,
117 #[serde(rename = "saml")]
118 Saml,
119 #[serde(rename = "link_recovery")]
120 LinkRecovery,
121 #[serde(rename = "code_recovery")]
122 CodeRecovery,
123}
124
125impl Default for ActiveEnum {
126 fn default() -> ActiveEnum {
127 Self::Password
128 }
129}
130