authentik_client/models/
patched_ldap_source_request.rs

1/*
2 * authentik
3 *
4 * Making authentication simple.
5 *
6 * The version of the OpenAPI document: 2025.8.4
7 * Contact: hello@goauthentik.io
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// PatchedLdapSourceRequest : LDAP Source Serializer
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct PatchedLdapSourceRequest {
17    /// Source's display Name.
18    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
19    pub name: Option<String>,
20    /// Internal source name, used in URLs.
21    #[serde(rename = "slug", skip_serializing_if = "Option::is_none")]
22    pub slug: Option<String>,
23    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
24    pub enabled: Option<bool>,
25    /// Flow to use when authenticating existing users.
26    #[serde(
27        rename = "authentication_flow",
28        default,
29        with = "::serde_with::rust::double_option",
30        skip_serializing_if = "Option::is_none"
31    )]
32    pub authentication_flow: Option<Option<uuid::Uuid>>,
33    /// Flow to use when enrolling new users.
34    #[serde(
35        rename = "enrollment_flow",
36        default,
37        with = "::serde_with::rust::double_option",
38        skip_serializing_if = "Option::is_none"
39    )]
40    pub enrollment_flow: Option<Option<uuid::Uuid>>,
41    #[serde(rename = "user_property_mappings", skip_serializing_if = "Option::is_none")]
42    pub user_property_mappings: Option<Vec<uuid::Uuid>>,
43    #[serde(rename = "group_property_mappings", skip_serializing_if = "Option::is_none")]
44    pub group_property_mappings: Option<Vec<uuid::Uuid>>,
45    #[serde(rename = "policy_engine_mode", skip_serializing_if = "Option::is_none")]
46    pub policy_engine_mode: Option<models::PolicyEngineMode>,
47    /// How the source determines if an existing user should be authenticated or a new user enrolled.
48    #[serde(rename = "user_matching_mode", skip_serializing_if = "Option::is_none")]
49    pub user_matching_mode: Option<models::UserMatchingModeEnum>,
50    #[serde(rename = "user_path_template", skip_serializing_if = "Option::is_none")]
51    pub user_path_template: Option<String>,
52    #[serde(rename = "server_uri", skip_serializing_if = "Option::is_none")]
53    pub server_uri: Option<String>,
54    /// Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair.
55    #[serde(
56        rename = "peer_certificate",
57        default,
58        with = "::serde_with::rust::double_option",
59        skip_serializing_if = "Option::is_none"
60    )]
61    pub peer_certificate: Option<Option<uuid::Uuid>>,
62    /// Client certificate to authenticate against the LDAP Server's Certificate.
63    #[serde(
64        rename = "client_certificate",
65        default,
66        with = "::serde_with::rust::double_option",
67        skip_serializing_if = "Option::is_none"
68    )]
69    pub client_certificate: Option<Option<uuid::Uuid>>,
70    #[serde(rename = "bind_cn", skip_serializing_if = "Option::is_none")]
71    pub bind_cn: Option<String>,
72    #[serde(rename = "bind_password", skip_serializing_if = "Option::is_none")]
73    pub bind_password: Option<String>,
74    #[serde(rename = "start_tls", skip_serializing_if = "Option::is_none")]
75    pub start_tls: Option<bool>,
76    #[serde(rename = "sni", skip_serializing_if = "Option::is_none")]
77    pub sni: Option<bool>,
78    #[serde(rename = "base_dn", skip_serializing_if = "Option::is_none")]
79    pub base_dn: Option<String>,
80    /// Prepended to Base DN for User-queries.
81    #[serde(rename = "additional_user_dn", skip_serializing_if = "Option::is_none")]
82    pub additional_user_dn: Option<String>,
83    /// Prepended to Base DN for Group-queries.
84    #[serde(rename = "additional_group_dn", skip_serializing_if = "Option::is_none")]
85    pub additional_group_dn: Option<String>,
86    /// Consider Objects matching this filter to be Users.
87    #[serde(rename = "user_object_filter", skip_serializing_if = "Option::is_none")]
88    pub user_object_filter: Option<String>,
89    /// Consider Objects matching this filter to be Groups.
90    #[serde(rename = "group_object_filter", skip_serializing_if = "Option::is_none")]
91    pub group_object_filter: Option<String>,
92    /// Field which contains members of a group.
93    #[serde(rename = "group_membership_field", skip_serializing_if = "Option::is_none")]
94    pub group_membership_field: Option<String>,
95    /// Attribute which matches the value of `group_membership_field`.
96    #[serde(rename = "user_membership_attribute", skip_serializing_if = "Option::is_none")]
97    pub user_membership_attribute: Option<String>,
98    /// Field which contains a unique Identifier.
99    #[serde(rename = "object_uniqueness_field", skip_serializing_if = "Option::is_none")]
100    pub object_uniqueness_field: Option<String>,
101    /// Update internal authentik password when login succeeds with LDAP
102    #[serde(
103        rename = "password_login_update_internal_password",
104        skip_serializing_if = "Option::is_none"
105    )]
106    pub password_login_update_internal_password: Option<bool>,
107    #[serde(rename = "sync_users", skip_serializing_if = "Option::is_none")]
108    pub sync_users: Option<bool>,
109    /// When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.
110    #[serde(rename = "sync_users_password", skip_serializing_if = "Option::is_none")]
111    pub sync_users_password: Option<bool>,
112    #[serde(rename = "sync_groups", skip_serializing_if = "Option::is_none")]
113    pub sync_groups: Option<bool>,
114    #[serde(
115        rename = "sync_parent_group",
116        default,
117        with = "::serde_with::rust::double_option",
118        skip_serializing_if = "Option::is_none"
119    )]
120    pub sync_parent_group: Option<Option<uuid::Uuid>>,
121    /// Lookup group membership based on a user attribute instead of a group attribute. This allows nested group resolution on systems like FreeIPA and Active Directory
122    #[serde(rename = "lookup_groups_from_user", skip_serializing_if = "Option::is_none")]
123    pub lookup_groups_from_user: Option<bool>,
124    /// Delete authentik users and groups which were previously supplied by this source, but are now missing from it.
125    #[serde(rename = "delete_not_found_objects", skip_serializing_if = "Option::is_none")]
126    pub delete_not_found_objects: Option<bool>,
127}
128
129impl PatchedLdapSourceRequest {
130    /// LDAP Source Serializer
131    pub fn new() -> PatchedLdapSourceRequest {
132        PatchedLdapSourceRequest {
133            name: None,
134            slug: None,
135            enabled: None,
136            authentication_flow: None,
137            enrollment_flow: None,
138            user_property_mappings: None,
139            group_property_mappings: None,
140            policy_engine_mode: None,
141            user_matching_mode: None,
142            user_path_template: None,
143            server_uri: None,
144            peer_certificate: None,
145            client_certificate: None,
146            bind_cn: None,
147            bind_password: None,
148            start_tls: None,
149            sni: None,
150            base_dn: None,
151            additional_user_dn: None,
152            additional_group_dn: None,
153            user_object_filter: None,
154            group_object_filter: None,
155            group_membership_field: None,
156            user_membership_attribute: None,
157            object_uniqueness_field: None,
158            password_login_update_internal_password: None,
159            sync_users: None,
160            sync_users_password: None,
161            sync_groups: None,
162            sync_parent_group: None,
163            lookup_groups_from_user: None,
164            delete_not_found_objects: None,
165        }
166    }
167}
authentik_client/models/patched_ldap_source_request.rs

authentik_client/models/
patched_ldap_source_request.rs
