authentik_client/models/
ldap_source.rs

1/*
2 * authentik
3 *
4 * Making authentication simple.
5 *
6 * The version of the OpenAPI document: 2026.2.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 = "icon_themed_urls", deserialize_with = "Option::deserialize")]
77    pub icon_themed_urls: Option<models::ThemedUrls>,
78    #[serde(rename = "server_uri")]
79    pub server_uri: String,
80    /// Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair.
81    #[serde(
82        rename = "peer_certificate",
83        default,
84        with = "::serde_with::rust::double_option",
85        skip_serializing_if = "Option::is_none"
86    )]
87    pub peer_certificate: Option<Option<uuid::Uuid>>,
88    /// Client certificate to authenticate against the LDAP Server's Certificate.
89    #[serde(
90        rename = "client_certificate",
91        default,
92        with = "::serde_with::rust::double_option",
93        skip_serializing_if = "Option::is_none"
94    )]
95    pub client_certificate: Option<Option<uuid::Uuid>>,
96    #[serde(rename = "bind_cn", skip_serializing_if = "Option::is_none")]
97    pub bind_cn: Option<String>,
98    #[serde(rename = "start_tls", skip_serializing_if = "Option::is_none")]
99    pub start_tls: Option<bool>,
100    #[serde(rename = "sni", skip_serializing_if = "Option::is_none")]
101    pub sni: Option<bool>,
102    #[serde(rename = "base_dn")]
103    pub base_dn: String,
104    /// Prepended to Base DN for User-queries.
105    #[serde(rename = "additional_user_dn", skip_serializing_if = "Option::is_none")]
106    pub additional_user_dn: Option<String>,
107    /// Prepended to Base DN for Group-queries.
108    #[serde(rename = "additional_group_dn", skip_serializing_if = "Option::is_none")]
109    pub additional_group_dn: Option<String>,
110    /// Consider Objects matching this filter to be Users.
111    #[serde(rename = "user_object_filter", skip_serializing_if = "Option::is_none")]
112    pub user_object_filter: Option<String>,
113    /// Consider Objects matching this filter to be Groups.
114    #[serde(rename = "group_object_filter", skip_serializing_if = "Option::is_none")]
115    pub group_object_filter: Option<String>,
116    /// Field which contains members of a group.
117    #[serde(rename = "group_membership_field", skip_serializing_if = "Option::is_none")]
118    pub group_membership_field: Option<String>,
119    /// Attribute which matches the value of `group_membership_field`.
120    #[serde(rename = "user_membership_attribute", skip_serializing_if = "Option::is_none")]
121    pub user_membership_attribute: Option<String>,
122    /// Field which contains a unique Identifier.
123    #[serde(rename = "object_uniqueness_field", skip_serializing_if = "Option::is_none")]
124    pub object_uniqueness_field: Option<String>,
125    /// Update internal authentik password when login succeeds with LDAP
126    #[serde(
127        rename = "password_login_update_internal_password",
128        skip_serializing_if = "Option::is_none"
129    )]
130    pub password_login_update_internal_password: Option<bool>,
131    #[serde(rename = "sync_users", skip_serializing_if = "Option::is_none")]
132    pub sync_users: Option<bool>,
133    /// When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.
134    #[serde(rename = "sync_users_password", skip_serializing_if = "Option::is_none")]
135    pub sync_users_password: Option<bool>,
136    #[serde(rename = "sync_groups", skip_serializing_if = "Option::is_none")]
137    pub sync_groups: Option<bool>,
138    #[serde(
139        rename = "sync_parent_group",
140        default,
141        with = "::serde_with::rust::double_option",
142        skip_serializing_if = "Option::is_none"
143    )]
144    pub sync_parent_group: Option<Option<uuid::Uuid>>,
145    /// Get cached source connectivity
146    #[serde(rename = "connectivity", deserialize_with = "Option::deserialize")]
147    pub connectivity: Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
148    /// 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
149    #[serde(rename = "lookup_groups_from_user", skip_serializing_if = "Option::is_none")]
150    pub lookup_groups_from_user: Option<bool>,
151    /// Delete authentik users and groups which were previously supplied by this source, but are now missing from it.
152    #[serde(rename = "delete_not_found_objects", skip_serializing_if = "Option::is_none")]
153    pub delete_not_found_objects: Option<bool>,
154    /// When to trigger sync for outgoing providers
155    #[serde(rename = "sync_outgoing_trigger_mode", skip_serializing_if = "Option::is_none")]
156    pub sync_outgoing_trigger_mode: Option<models::SyncOutgoingTriggerModeEnum>,
157}
158
159impl LdapSource {
160    /// LDAP Source Serializer
161    pub fn new(
162        pk: uuid::Uuid,
163        name: String,
164        slug: String,
165        component: String,
166        verbose_name: String,
167        verbose_name_plural: String,
168        meta_model_name: String,
169        managed: Option<String>,
170        icon_url: String,
171        icon_themed_urls: Option<models::ThemedUrls>,
172        server_uri: String,
173        base_dn: String,
174        connectivity: Option<std::collections::HashMap<String, std::collections::HashMap<String, String>>>,
175    ) -> LdapSource {
176        LdapSource {
177            pk,
178            name,
179            slug,
180            enabled: None,
181            promoted: None,
182            authentication_flow: None,
183            enrollment_flow: None,
184            user_property_mappings: None,
185            group_property_mappings: None,
186            component,
187            verbose_name,
188            verbose_name_plural,
189            meta_model_name,
190            policy_engine_mode: None,
191            user_matching_mode: None,
192            managed,
193            user_path_template: None,
194            icon: None,
195            icon_url,
196            icon_themed_urls,
197            server_uri,
198            peer_certificate: None,
199            client_certificate: None,
200            bind_cn: None,
201            start_tls: None,
202            sni: None,
203            base_dn,
204            additional_user_dn: None,
205            additional_group_dn: None,
206            user_object_filter: None,
207            group_object_filter: None,
208            group_membership_field: None,
209            user_membership_attribute: None,
210            object_uniqueness_field: None,
211            password_login_update_internal_password: None,
212            sync_users: None,
213            sync_users_password: None,
214            sync_groups: None,
215            sync_parent_group: None,
216            connectivity,
217            lookup_groups_from_user: None,
218            delete_not_found_objects: None,
219            sync_outgoing_trigger_mode: None,
220        }
221    }
222}
authentik_client/models/ldap_source.rs

authentik_client/models/
ldap_source.rs
