zitadel 3.4.27

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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400

// @generated
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RequestChallenges {
    #[prost(message, optional, tag="1")]
    pub web_auth_n: ::core::option::Option<request_challenges::WebAuthN>,
    #[prost(message, optional, tag="2")]
    pub otp_sms: ::core::option::Option<request_challenges::Otpsms>,
    #[prost(message, optional, tag="3")]
    pub otp_email: ::core::option::Option<request_challenges::OtpEmail>,
}
/// Nested message and enum types in `RequestChallenges`.
pub mod request_challenges {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
    pub struct WebAuthN {
        #[prost(string, tag="1")]
        pub domain: ::prost::alloc::string::String,
        #[prost(enumeration="super::UserVerificationRequirement", tag="2")]
        pub user_verification_requirement: i32,
    }
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
    pub struct Otpsms {
        #[prost(bool, tag="1")]
        pub return_code: bool,
    }
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
    pub struct OtpEmail {
        /// if no delivery_type is specified, an email is sent with the default url
        #[prost(oneof="otp_email::DeliveryType", tags="2, 3")]
        pub delivery_type: ::core::option::Option<otp_email::DeliveryType>,
    }
    /// Nested message and enum types in `OTPEmail`.
    pub mod otp_email {
        #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
        pub struct SendCode {
            #[prost(string, optional, tag="1")]
            pub url_template: ::core::option::Option<::prost::alloc::string::String>,
        }
        #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
        pub struct ReturnCode {
        }
        /// if no delivery_type is specified, an email is sent with the default url
        #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
        pub enum DeliveryType {
            #[prost(message, tag="2")]
            SendCode(SendCode),
            #[prost(message, tag="3")]
            ReturnCode(ReturnCode),
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Challenges {
    #[prost(message, optional, tag="1")]
    pub web_auth_n: ::core::option::Option<challenges::WebAuthN>,
    #[prost(string, optional, tag="2")]
    pub otp_sms: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(string, optional, tag="3")]
    pub otp_email: ::core::option::Option<::prost::alloc::string::String>,
}
/// Nested message and enum types in `Challenges`.
pub mod challenges {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
    pub struct WebAuthN {
        #[prost(message, optional, tag="1")]
        pub public_key_credential_request_options: ::core::option::Option<::pbjson_types::Struct>,
    }
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum UserVerificationRequirement {
    Unspecified = 0,
    Required = 1,
    Preferred = 2,
    Discouraged = 3,
}
impl UserVerificationRequirement {
    /// 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 {
            UserVerificationRequirement::Unspecified => "USER_VERIFICATION_REQUIREMENT_UNSPECIFIED",
            UserVerificationRequirement::Required => "USER_VERIFICATION_REQUIREMENT_REQUIRED",
            UserVerificationRequirement::Preferred => "USER_VERIFICATION_REQUIREMENT_PREFERRED",
            UserVerificationRequirement::Discouraged => "USER_VERIFICATION_REQUIREMENT_DISCOURAGED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "USER_VERIFICATION_REQUIREMENT_UNSPECIFIED" => Some(Self::Unspecified),
            "USER_VERIFICATION_REQUIREMENT_REQUIRED" => Some(Self::Required),
            "USER_VERIFICATION_REQUIREMENT_PREFERRED" => Some(Self::Preferred),
            "USER_VERIFICATION_REQUIREMENT_DISCOURAGED" => Some(Self::Discouraged),
            _ => None,
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Session {
    #[prost(string, tag="1")]
    pub id: ::prost::alloc::string::String,
    #[prost(message, optional, tag="2")]
    pub creation_date: ::core::option::Option<::pbjson_types::Timestamp>,
    #[prost(message, optional, tag="3")]
    pub change_date: ::core::option::Option<::pbjson_types::Timestamp>,
    #[prost(uint64, tag="4")]
    pub sequence: u64,
    #[prost(message, optional, tag="5")]
    pub factors: ::core::option::Option<Factors>,
    #[prost(map="string, bytes", tag="6")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::vec::Vec<u8>>,
    #[prost(message, optional, tag="7")]
    pub user_agent: ::core::option::Option<UserAgent>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Factors {
    #[prost(message, optional, tag="1")]
    pub user: ::core::option::Option<UserFactor>,
    #[prost(message, optional, tag="2")]
    pub password: ::core::option::Option<PasswordFactor>,
    #[prost(message, optional, tag="3")]
    pub web_auth_n: ::core::option::Option<WebAuthNFactor>,
    #[prost(message, optional, tag="4")]
    pub intent: ::core::option::Option<IntentFactor>,
    #[prost(message, optional, tag="5")]
    pub totp: ::core::option::Option<TotpFactor>,
    #[prost(message, optional, tag="6")]
    pub otp_sms: ::core::option::Option<OtpFactor>,
    #[prost(message, optional, tag="7")]
    pub otp_email: ::core::option::Option<OtpFactor>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
    #[prost(string, tag="2")]
    pub id: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub login_name: ::prost::alloc::string::String,
    #[prost(string, tag="4")]
    pub display_name: ::prost::alloc::string::String,
    /// deprecated: use organization_id, will be remove before GA (<https://github.com/zitadel/zitadel/issues/6718>)
    #[prost(string, tag="5")]
    pub organisation_id: ::prost::alloc::string::String,
    #[prost(string, tag="6")]
    pub organization_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PasswordFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IntentFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WebAuthNFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
    #[prost(bool, tag="2")]
    pub user_verified: bool,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TotpFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OtpFactor {
    #[prost(message, optional, tag="1")]
    pub verified_at: ::core::option::Option<::pbjson_types::Timestamp>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchQuery {
    #[prost(oneof="search_query::Query", tags="1")]
    pub query: ::core::option::Option<search_query::Query>,
}
/// Nested message and enum types in `SearchQuery`.
pub mod search_query {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Query {
        #[prost(message, tag="1")]
        IdsQuery(super::IDsQuery),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IDsQuery {
    #[prost(string, repeated, tag="1")]
    pub ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserAgent {
    #[prost(string, optional, tag="1")]
    pub fingerprint_id: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(string, optional, tag="2")]
    pub ip: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(string, optional, tag="3")]
    pub description: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(map="string, message", tag="4")]
    pub header: ::std::collections::HashMap<::prost::alloc::string::String, user_agent::HeaderValues>,
}
/// Nested message and enum types in `UserAgent`.
pub mod user_agent {
    /// A header may have multiple values.
    /// In Go, headers are defined
    /// as map\[string][\]string, but protobuf
    /// doesn't allow this scheme.
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
    pub struct HeaderValues {
        #[prost(string, repeated, tag="1")]
        pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSessionsRequest {
    #[prost(message, optional, tag="1")]
    pub query: ::core::option::Option<super::super::object::v2beta::ListQuery>,
    #[prost(message, repeated, tag="2")]
    pub queries: ::prost::alloc::vec::Vec<SearchQuery>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSessionsResponse {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::object::v2beta::ListDetails>,
    #[prost(message, repeated, tag="2")]
    pub sessions: ::prost::alloc::vec::Vec<Session>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSessionRequest {
    #[prost(string, tag="1")]
    pub session_id: ::prost::alloc::string::String,
    #[prost(string, optional, tag="2")]
    pub session_token: ::core::option::Option<::prost::alloc::string::String>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSessionResponse {
    #[prost(message, optional, tag="1")]
    pub session: ::core::option::Option<Session>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSessionRequest {
    #[prost(message, optional, tag="1")]
    pub checks: ::core::option::Option<Checks>,
    #[prost(map="string, bytes", tag="2")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::vec::Vec<u8>>,
    #[prost(message, optional, tag="3")]
    pub challenges: ::core::option::Option<RequestChallenges>,
    #[prost(message, optional, tag="4")]
    pub user_agent: ::core::option::Option<UserAgent>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSessionResponse {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::object::v2beta::Details>,
    #[prost(string, tag="2")]
    pub session_id: ::prost::alloc::string::String,
    #[prost(string, tag="3")]
    pub session_token: ::prost::alloc::string::String,
    #[prost(message, optional, tag="4")]
    pub challenges: ::core::option::Option<Challenges>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SetSessionRequest {
    #[prost(string, tag="1")]
    pub session_id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub session_token: ::prost::alloc::string::String,
    #[prost(message, optional, tag="3")]
    pub checks: ::core::option::Option<Checks>,
    #[prost(map="string, bytes", tag="4")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::vec::Vec<u8>>,
    #[prost(message, optional, tag="5")]
    pub challenges: ::core::option::Option<RequestChallenges>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SetSessionResponse {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::object::v2beta::Details>,
    #[prost(string, tag="2")]
    pub session_token: ::prost::alloc::string::String,
    #[prost(message, optional, tag="3")]
    pub challenges: ::core::option::Option<Challenges>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSessionRequest {
    #[prost(string, tag="1")]
    pub session_id: ::prost::alloc::string::String,
    #[prost(string, optional, tag="2")]
    pub session_token: ::core::option::Option<::prost::alloc::string::String>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSessionResponse {
    #[prost(message, optional, tag="1")]
    pub details: ::core::option::Option<super::super::object::v2beta::Details>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Checks {
    #[prost(message, optional, tag="1")]
    pub user: ::core::option::Option<CheckUser>,
    #[prost(message, optional, tag="2")]
    pub password: ::core::option::Option<CheckPassword>,
    #[prost(message, optional, tag="3")]
    pub web_auth_n: ::core::option::Option<CheckWebAuthN>,
    #[prost(message, optional, tag="4")]
    pub idp_intent: ::core::option::Option<CheckIdpIntent>,
    #[prost(message, optional, tag="5")]
    pub totp: ::core::option::Option<CheckTotp>,
    #[prost(message, optional, tag="6")]
    pub otp_sms: ::core::option::Option<CheckOtp>,
    #[prost(message, optional, tag="7")]
    pub otp_email: ::core::option::Option<CheckOtp>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckUser {
    #[prost(oneof="check_user::Search", tags="1, 2")]
    pub search: ::core::option::Option<check_user::Search>,
}
/// Nested message and enum types in `CheckUser`.
pub mod check_user {
    #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Search {
        #[prost(string, tag="1")]
        UserId(::prost::alloc::string::String),
        #[prost(string, tag="2")]
        LoginName(::prost::alloc::string::String),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckPassword {
    #[prost(string, tag="1")]
    pub password: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckWebAuthN {
    #[prost(message, optional, tag="1")]
    pub credential_assertion_data: ::core::option::Option<::pbjson_types::Struct>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckIdpIntent {
    #[prost(string, tag="1")]
    pub idp_intent_id: ::prost::alloc::string::String,
    #[prost(string, tag="2")]
    pub idp_intent_token: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckTotp {
    #[prost(string, tag="1")]
    pub code: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckOtp {
    #[prost(string, tag="1")]
    pub code: ::prost::alloc::string::String,
}
include!("zitadel.session.v2beta.tonic.rs");
// @@protoc_insertion_point(module)