clerk_rs/models/update_instance_auth_config_request.rs
1/*
2 * Clerk Backend API
3 *
4 * The Clerk REST Backend API, meant to be accessed by backend servers. Please see https://clerk.com/docs for more information.
5 *
6 * The version of the OpenAPI document: v1
7 * Contact: support@clerk.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
12pub struct UpdateInstanceAuthConfigRequest {
13 /// Whether sign up is restricted to email addresses, phone numbers and usernames that are on the allowlist.
14 #[serde(rename = "restricted_to_allowlist", skip_serializing_if = "Option::is_none")]
15 pub restricted_to_allowlist: Option<bool>,
16 /// The local part of the email address from which authentication-related emails (e.g. OTP code, magic links) will be sent. Only alphanumeric values are allowed. Note that this value should contain only the local part of the address (e.g. `foo` for `foo@example.com`).
17 #[serde(rename = "from_email_address", skip_serializing_if = "Option::is_none")]
18 pub from_email_address: Option<String>,
19 /// Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info.
20 #[serde(rename = "progressive_sign_up", skip_serializing_if = "Option::is_none")]
21 pub progressive_sign_up: Option<bool>,
22 /// The name of the JWT Template used to augment your session tokens. To disable this, pass an empty string.
23 #[serde(rename = "session_token_template", skip_serializing_if = "Option::is_none")]
24 pub session_token_template: Option<String>,
25 /// The \"enhanced_email_deliverability\" feature will send emails from \"verifications@clerk.dev\" instead of your domain. This can be helpful if you do not have a high domain reputation.
26 #[serde(rename = "enhanced_email_deliverability", skip_serializing_if = "Option::is_none")]
27 pub enhanced_email_deliverability: Option<bool>,
28 /// Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances.
29 #[serde(rename = "test_mode", skip_serializing_if = "Option::is_none")]
30 pub test_mode: Option<bool>,
31}
32
33impl UpdateInstanceAuthConfigRequest {
34 pub fn new() -> UpdateInstanceAuthConfigRequest {
35 UpdateInstanceAuthConfigRequest {
36 restricted_to_allowlist: None,
37 from_email_address: None,
38 progressive_sign_up: None,
39 session_token_template: None,
40 enhanced_email_deliverability: None,
41 test_mode: None,
42 }
43 }
44}