zitadel 5.2.0

An implementation of ZITADEL API access and authentication in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

// @generated
// This file is @generated by prost-build.
/// deprecated: please use DomainPolicy instead
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OrgIamPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(bool, tag="2")]
    pub user_login_must_be_domain: bool,
    #[prost(bool, tag="3")]
    pub is_default: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DomainPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(bool, tag="2")]
    pub user_login_must_be_domain: bool,
    #[prost(bool, tag="3")]
    pub is_default: bool,
    #[prost(bool, tag="4")]
    pub validate_org_domains: bool,
    #[prost(bool, tag="5")]
    pub smtp_sender_address_matches_instance_domain: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LabelPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    /// hex value for primary color
    #[prost(string, tag="2")]
    pub primary_color: ::prost::alloc::string::String,
    /// defines if the organization's admin changed the policy
    #[prost(bool, tag="4")]
    pub is_default: bool,
    /// hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set
    #[prost(bool, tag="5")]
    pub hide_login_name_suffix: bool,
    /// hex value for secondary color
    #[prost(string, tag="6")]
    pub warn_color: ::prost::alloc::string::String,
    /// hex value for background color
    #[prost(string, tag="7")]
    pub background_color: ::prost::alloc::string::String,
    /// hex value for font color
    #[prost(string, tag="8")]
    pub font_color: ::prost::alloc::string::String,
    /// hex value for primary color dark theme
    #[prost(string, tag="9")]
    pub primary_color_dark: ::prost::alloc::string::String,
    /// hex value for background color dark theme
    #[prost(string, tag="10")]
    pub background_color_dark: ::prost::alloc::string::String,
    /// hex value for warning color dark theme
    #[prost(string, tag="11")]
    pub warn_color_dark: ::prost::alloc::string::String,
    /// hex value for font color dark theme
    #[prost(string, tag="12")]
    pub font_color_dark: ::prost::alloc::string::String,
    #[prost(bool, tag="13")]
    pub disable_watermark: bool,
    #[prost(string, tag="14")]
    pub logo_url: ::prost::alloc::string::String,
    #[prost(string, tag="15")]
    pub icon_url: ::prost::alloc::string::String,
    #[prost(string, tag="16")]
    pub logo_url_dark: ::prost::alloc::string::String,
    #[prost(string, tag="17")]
    pub icon_url_dark: ::prost::alloc::string::String,
    #[prost(string, tag="18")]
    pub font_url: ::prost::alloc::string::String,
    #[prost(enumeration="ThemeMode", tag="19")]
    pub theme_mode: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LoginPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(bool, tag="2")]
    pub allow_username_password: bool,
    #[prost(bool, tag="3")]
    pub allow_register: bool,
    #[prost(bool, tag="4")]
    pub allow_external_idp: bool,
    #[prost(bool, tag="5")]
    pub force_mfa: bool,
    #[prost(enumeration="PasswordlessType", tag="6")]
    pub passwordless_type: i32,
    #[prost(bool, tag="7")]
    pub is_default: bool,
    #[prost(bool, tag="8")]
    pub hide_password_reset: bool,
    #[prost(bool, tag="9")]
    pub ignore_unknown_usernames: bool,
    #[prost(string, tag="10")]
    pub default_redirect_uri: ::prost::alloc::string::String,
    #[prost(message, optional, tag="11")]
    pub password_check_lifetime: ::core::option::Option<::pbjson_types::Duration>,
    #[prost(message, optional, tag="12")]
    pub external_login_check_lifetime: ::core::option::Option<::pbjson_types::Duration>,
    #[prost(message, optional, tag="13")]
    pub mfa_init_skip_lifetime: ::core::option::Option<::pbjson_types::Duration>,
    #[prost(message, optional, tag="14")]
    pub second_factor_check_lifetime: ::core::option::Option<::pbjson_types::Duration>,
    #[prost(message, optional, tag="15")]
    pub multi_factor_check_lifetime: ::core::option::Option<::pbjson_types::Duration>,
    #[prost(enumeration="SecondFactorType", repeated, tag="16")]
    pub second_factors: ::prost::alloc::vec::Vec<i32>,
    #[prost(enumeration="MultiFactorType", repeated, tag="17")]
    pub multi_factors: ::prost::alloc::vec::Vec<i32>,
    #[prost(message, repeated, tag="18")]
    pub idps: ::prost::alloc::vec::Vec<super::super::idp::v1::IdpLoginPolicyLink>,
    /// If set to true, the suffix (@domain.com) of an unknown username input on the login screen will be matched against the org domains and will redirect to the registration of that organization on success.
    #[prost(bool, tag="19")]
    pub allow_domain_discovery: bool,
    #[prost(bool, tag="20")]
    pub disable_login_with_email: bool,
    #[prost(bool, tag="21")]
    pub disable_login_with_phone: bool,
    #[prost(bool, tag="22")]
    pub force_mfa_local_only: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PasswordComplexityPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(uint64, tag="2")]
    pub min_length: u64,
    #[prost(bool, tag="3")]
    pub has_uppercase: bool,
    #[prost(bool, tag="4")]
    pub has_lowercase: bool,
    #[prost(bool, tag="5")]
    pub has_number: bool,
    #[prost(bool, tag="6")]
    pub has_symbol: bool,
    #[prost(bool, tag="7")]
    pub is_default: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PasswordAgePolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    /// Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.
    #[prost(uint64, tag="2")]
    pub max_age_days: u64,
    /// Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.
    #[prost(uint64, tag="3")]
    pub expire_warn_days: u64,
    /// If true, the returned values represent the instance settings, e.g. by an organization without custom settings.
    #[prost(bool, tag="4")]
    pub is_default: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LockoutPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(uint64, tag="2")]
    pub max_password_attempts: u64,
    #[prost(uint64, tag="3")]
    pub max_otp_attempts: u64,
    #[prost(bool, tag="4")]
    pub is_default: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PrivacyPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(string, tag="2")]
    pub tos_link: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub privacy_link: ::prost::alloc::string::String,
    #[prost(bool, tag="4")]
    pub is_default: bool,
    #[prost(string, tag="5")]
    pub help_link: ::prost::alloc::string::String,
    #[prost(string, tag="6")]
    pub support_email: ::prost::alloc::string::String,
    #[prost(string, tag="7")]
    pub docs_link: ::prost::alloc::string::String,
    #[prost(string, tag="8")]
    pub custom_link: ::prost::alloc::string::String,
    #[prost(string, tag="9")]
    pub custom_link_text: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NotificationPolicy {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::v1::ObjectDetails>,
    #[prost(bool, tag="2")]
    pub is_default: bool,
    #[prost(bool, tag="3")]
    pub password_change: bool,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ThemeMode {
    Unspecified = 0,
    Auto = 1,
    Dark = 2,
    Light = 3,
}
impl ThemeMode {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            ThemeMode::Unspecified => "THEME_MODE_UNSPECIFIED",
            ThemeMode::Auto => "THEME_MODE_AUTO",
            ThemeMode::Dark => "THEME_MODE_DARK",
            ThemeMode::Light => "THEME_MODE_LIGHT",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "THEME_MODE_UNSPECIFIED" => Some(Self::Unspecified),
            "THEME_MODE_AUTO" => Some(Self::Auto),
            "THEME_MODE_DARK" => Some(Self::Dark),
            "THEME_MODE_LIGHT" => Some(Self::Light),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SecondFactorType {
    Unspecified = 0,
    /// SECOND_FACTOR_TYPE_OTP is the type for TOTP
    Otp = 1,
    U2f = 2,
    OtpEmail = 3,
    OtpSms = 4,
}
impl SecondFactorType {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            SecondFactorType::Unspecified => "SECOND_FACTOR_TYPE_UNSPECIFIED",
            SecondFactorType::Otp => "SECOND_FACTOR_TYPE_OTP",
            SecondFactorType::U2f => "SECOND_FACTOR_TYPE_U2F",
            SecondFactorType::OtpEmail => "SECOND_FACTOR_TYPE_OTP_EMAIL",
            SecondFactorType::OtpSms => "SECOND_FACTOR_TYPE_OTP_SMS",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "SECOND_FACTOR_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "SECOND_FACTOR_TYPE_OTP" => Some(Self::Otp),
            "SECOND_FACTOR_TYPE_U2F" => Some(Self::U2f),
            "SECOND_FACTOR_TYPE_OTP_EMAIL" => Some(Self::OtpEmail),
            "SECOND_FACTOR_TYPE_OTP_SMS" => Some(Self::OtpSms),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum MultiFactorType {
    Unspecified = 0,
    U2fWithVerification = 1,
}
impl MultiFactorType {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            MultiFactorType::Unspecified => "MULTI_FACTOR_TYPE_UNSPECIFIED",
            MultiFactorType::U2fWithVerification => "MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "MULTI_FACTOR_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
            "MULTI_FACTOR_TYPE_U2F_WITH_VERIFICATION" => Some(Self::U2fWithVerification),
            _ => None,
        }
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PasswordlessType {
    NotAllowed = 0,
    /// PLANNED: PASSWORDLESS_TYPE_WITH_CERT
    Allowed = 1,
}
impl PasswordlessType {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            PasswordlessType::NotAllowed => "PASSWORDLESS_TYPE_NOT_ALLOWED",
            PasswordlessType::Allowed => "PASSWORDLESS_TYPE_ALLOWED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "PASSWORDLESS_TYPE_NOT_ALLOWED" => Some(Self::NotAllowed),
            "PASSWORDLESS_TYPE_ALLOWED" => Some(Self::Allowed),
            _ => None,
        }
    }
}
// @@protoc_insertion_point(module)