authentik_client/models/
ldap_source.rs

1/*
2 * authentik
3 *
4 * Making authentication simple.
5 *
6 * The version of the OpenAPI document: 2025.12.1
7 * Contact: hello@goauthentik.io
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// LdapSource : LDAP Source Serializer
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct LdapSource {
17    #[serde(rename = "pk")]
18    pub pk: uuid::Uuid,
19    /// Source's display Name.
20    #[serde(rename = "name")]
21    pub name: String,
22    /// Internal source name, used in URLs.
23    #[serde(rename = "slug")]
24    pub slug: String,
25    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
26    pub enabled: Option<bool>,
27    /// When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
28    #[serde(rename = "promoted", skip_serializing_if = "Option::is_none")]
29    pub promoted: Option<bool>,
30    /// Flow to use when authenticating existing users.
31    #[serde(
32        rename = "authentication_flow",
33        default,
34        with = "::serde_with::rust::double_option",
35        skip_serializing_if = "Option::is_none"
36    )]
37    pub authentication_flow: Option<Option<uuid::Uuid>>,
38    /// Flow to use when enrolling new users.
39    #[serde(
40        rename = "enrollment_flow",
41        default,
42        with = "::serde_with::rust::double_option",
43        skip_serializing_if = "Option::is_none"
44    )]
45    pub enrollment_flow: Option<Option<uuid::Uuid>>,
46    #[serde(rename = "user_property_mappings", skip_serializing_if = "Option::is_none")]
47    pub user_property_mappings: Option<Vec<uuid::Uuid>>,
48    #[serde(rename = "group_property_mappings", skip_serializing_if = "Option::is_none")]
49    pub group_property_mappings: Option<Vec<uuid::Uuid>>,
50    /// Get object component so that we know how to edit the object
51    #[serde(rename = "component")]
52    pub component: String,
53    /// Return object's verbose_name
54    #[serde(rename = "verbose_name")]
55    pub verbose_name: String,
56    /// Return object's plural verbose_name
57    #[serde(rename = "verbose_name_plural")]
58    pub verbose_name_plural: String,
59    /// Return internal model name
60    #[serde(rename = "meta_model_name")]
61    pub meta_model_name: String,
62    #[serde(rename = "policy_engine_mode", skip_serializing_if = "Option::is_none")]
63    pub policy_engine_mode: Option<models::PolicyEngineMode>,
64    /// How the source determines if an existing user should be authenticated or a new user enrolled.
65    #[serde(rename = "user_matching_mode", skip_serializing_if = "Option::is_none")]
66    pub user_matching_mode: Option<models::UserMatchingModeEnum>,
67    /// Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
68    #[serde(rename = "managed", deserialize_with = "Option::deserialize")]
69    pub managed: Option<String>,
70    #[serde(rename = "user_path_template", skip_serializing_if = "Option::is_none")]
71    pub user_path_template: Option<String>,
72    #[serde(rename = "icon", skip_serializing_if = "Option::is_none")]
73    pub icon: Option<String>,
74    #[serde(rename = "icon_url")]
75    pub icon_url: String,
76    #[serde(rename = "server_uri")]
77    pub server_uri: String,
78    /// Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair.
79    #[serde(
80        rename = "peer_certificate",
81        default,
82        with = "::serde_with::rust::double_option",
83        skip_serializing_if = "Option::is_none"
84    )]
85    pub peer_certificate: Option<Option<uuid::Uuid>>,
86    /// Client certificate to authenticate against the LDAP Server's Certificate.
87    #[serde(
88        rename = "client_certificate",
89        default,
90        with = "::serde_with::rust::double_option",
91        skip_serializing_if = "Option::is_none"
92    )]
93    pub client_certificate: Option<Option<uuid::Uuid>>,
94    #[serde(rename = "bind_cn", skip_serializing_if = "Option::is_none")]
95    pub bind_cn: Option<String>,
96    #[serde(rename = "start_tls", skip_serializing_if = "Option::is_none")]
97    pub start_tls: Option<bool>,
98    #[serde(rename = "sni", skip_serializing_if = "Option::is_none")]
99    pub sni: Option<bool>,
100    #[serde(rename = "base_dn")]
101    pub base_dn: String,
102    /// Prepended to Base DN for User-queries.
103    #[serde(rename = "additional_user_dn", skip_serializing_if = "Option::is_none")]
104    pub additional_user_dn: Option<String>,
105    /// Prepended to Base DN for Group-queries.
106    #[serde(rename = "additional_group_dn", skip_serializing_if = "Option::is_none")]
107    pub additional_group_dn: Option<String>,
108    /// Consider Objects matching this filter to be Users.
109    #[serde(rename = "user_object_filter", skip_serializing_if = "Option::is_none")]
110    pub user_object_filter: Option<String>,
111    /// Consider Objects matching this filter to be Groups.
112    #[serde(rename = "group_object_filter", skip_serializing_if = "Option::is_none")]
113    pub group_object_filter: Option<String>,
114    /// Field which contains members of a group.
115    #[serde(rename = "group_membership_field", skip_serializing_if = "Option::is_none")]
116    pub group_membership_field: Option<String>,
117    /// Attribute which matches the value of `group_membership_field`.
118    #[serde(rename = "user_membership_attribute", skip_serializing_if = "Option::is_none")]
119    pub user_membership_attribute: Option<String>,
120    /// Field which contains a unique Identifier.
121    #[serde(rename = "object_uniqueness_field", skip_serializing_if = "Option::is_none")]
122    pub object_uniqueness_field: Option<String>,
123    /// Update internal authentik password when login succeeds with LDAP
124    #[serde(
125        rename = "password_login_update_internal_password",
126        skip_serializing_if = "Option::is_none"
127    )]
128    pub password_login_update_internal_password: Option<bool>,
129    #[serde(rename = "sync_users", skip_serializing_if = "Option::is_none")]
130    pub sync_users: Option<bool>,
131    /// When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.
132    #[serde(rename = "sync_users_password", skip_serializing_if = "Option::is_none")]
133    pub sync_users_password: Option<bool>,
134    #[serde(rename = "sync_groups", skip_serializing_if = "Option::is_none")]
135    pub sync_groups: Option<bool>,
136    #[serde(
137        rename = "sync_parent_group",
138        default,
139        with = "::serde_with::rust::double_option",
140        skip_serializing_if = "Option::is_none"
141    )]
142    pub sync_parent_group: Option<Option<uuid::Uuid>>,
143    /// Get cached source connectivity
144    #[serde(rename = "connectivity", deserialize_with = "Option::deserialize")]
145    pub connectivity: Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
146    /// 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
147    #[serde(rename = "lookup_groups_from_user", skip_serializing_if = "Option::is_none")]
148    pub lookup_groups_from_user: Option<bool>,
149    /// Delete authentik users and groups which were previously supplied by this source, but are now missing from it.
150    #[serde(rename = "delete_not_found_objects", skip_serializing_if = "Option::is_none")]
151    pub delete_not_found_objects: Option<bool>,
152    /// When to trigger sync for outgoing providers
153    #[serde(rename = "sync_outgoing_trigger_mode", skip_serializing_if = "Option::is_none")]
154    pub sync_outgoing_trigger_mode: Option<models::SyncOutgoingTriggerModeEnum>,
155}
156
157impl LdapSource {
158    /// LDAP Source Serializer
159    pub fn new(
160        pk: uuid::Uuid,
161        name: String,
162        slug: String,
163        component: String,
164        verbose_name: String,
165        verbose_name_plural: String,
166        meta_model_name: String,
167        managed: Option<String>,
168        icon_url: String,
169        server_uri: String,
170        base_dn: String,
171        connectivity: Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
172    ) -> LdapSource {
173        LdapSource {
174            pk,
175            name,
176            slug,
177            enabled: None,
178            promoted: None,
179            authentication_flow: None,
180            enrollment_flow: None,
181            user_property_mappings: None,
182            group_property_mappings: None,
183            component,
184            verbose_name,
185            verbose_name_plural,
186            meta_model_name,
187            policy_engine_mode: None,
188            user_matching_mode: None,
189            managed,
190            user_path_template: None,
191            icon: None,
192            icon_url,
193            server_uri,
194            peer_certificate: None,
195            client_certificate: None,
196            bind_cn: None,
197            start_tls: None,
198            sni: None,
199            base_dn,
200            additional_user_dn: None,
201            additional_group_dn: None,
202            user_object_filter: None,
203            group_object_filter: None,
204            group_membership_field: None,
205            user_membership_attribute: None,
206            object_uniqueness_field: None,
207            password_login_update_internal_password: None,
208            sync_users: None,
209            sync_users_password: None,
210            sync_groups: None,
211            sync_parent_group: None,
212            connectivity,
213            lookup_groups_from_user: None,
214            delete_not_found_objects: None,
215            sync_outgoing_trigger_mode: None,
216        }
217    }
218}
authentik_client/models/ldap_source.rs

authentik_client/models/
ldap_source.rs
