ory_client/models/registration_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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct RegistrationFlow {
16 /// 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
17 #[serde(rename = "active", skip_serializing_if = "Option::is_none")]
18 pub active: Option<ActiveEnum>,
19 /// ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.
20 #[serde(rename = "expires_at")]
21 pub expires_at: String,
22 /// 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=<id>
23 #[serde(rename = "id")]
24 pub id: String,
25 /// 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.
26 #[serde(rename = "identity_schema", skip_serializing_if = "Option::is_none")]
27 pub identity_schema: Option<String>,
28 /// IssuedAt is the time (UTC) when the flow occurred.
29 #[serde(rename = "issued_at")]
30 pub issued_at: String,
31 /// 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.
32 #[serde(rename = "oauth2_login_challenge", skip_serializing_if = "Option::is_none")]
33 pub oauth2_login_challenge: Option<String>,
34 #[serde(rename = "oauth2_login_request", skip_serializing_if = "Option::is_none")]
35 pub oauth2_login_request: Option<Box<models::OAuth2LoginRequest>>,
36 #[serde(rename = "organization_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
37 pub organization_id: Option<Option<String>>,
38 /// 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.
39 #[serde(rename = "request_url")]
40 pub request_url: String,
41 /// ReturnTo contains the requested return_to URL.
42 #[serde(rename = "return_to", skip_serializing_if = "Option::is_none")]
43 pub return_to: Option<String>,
44 /// 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.
45 #[serde(rename = "session_token_exchange_code", skip_serializing_if = "Option::is_none")]
46 pub session_token_exchange_code: Option<String>,
47 /// 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.
48 #[serde(rename = "state", deserialize_with = "Option::deserialize")]
49 pub state: Option<serde_json::Value>,
50 /// TransientPayload is used to pass data from the registration to a webhook
51 #[serde(rename = "transient_payload", skip_serializing_if = "Option::is_none")]
52 pub transient_payload: Option<serde_json::Value>,
53 /// The flow type can either be `api` or `browser`.
54 #[serde(rename = "type")]
55 pub r#type: String,
56 #[serde(rename = "ui")]
57 pub ui: Box<models::UiContainer>,
58}
59
60impl RegistrationFlow {
61 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) -> RegistrationFlow {
62 RegistrationFlow {
63 active: None,
64 expires_at,
65 id,
66 identity_schema: None,
67 issued_at,
68 oauth2_login_challenge: None,
69 oauth2_login_request: None,
70 organization_id: None,
71 request_url,
72 return_to: None,
73 session_token_exchange_code: None,
74 state,
75 transient_payload: None,
76 r#type,
77 ui: Box::new(ui),
78 }
79 }
80}
81/// 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
82#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
83pub enum ActiveEnum {
84 #[serde(rename = "password")]
85 Password,
86 #[serde(rename = "oidc")]
87 Oidc,
88 #[serde(rename = "totp")]
89 Totp,
90 #[serde(rename = "lookup_secret")]
91 LookupSecret,
92 #[serde(rename = "webauthn")]
93 Webauthn,
94 #[serde(rename = "code")]
95 Code,
96 #[serde(rename = "passkey")]
97 Passkey,
98 #[serde(rename = "profile")]
99 Profile,
100 #[serde(rename = "saml")]
101 Saml,
102 #[serde(rename = "link_recovery")]
103 LinkRecovery,
104 #[serde(rename = "code_recovery")]
105 CodeRecovery,
106}
107
108impl Default for ActiveEnum {
109 fn default() -> ActiveEnum {
110 Self::Password
111 }
112}
113