Skip to main content

authentik_client/models/
kerberos_source_request.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/// KerberosSourceRequest : Kerberos Source Serializer
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct KerberosSourceRequest {
17    /// Source's display Name.
18    #[serde(rename = "name")]
19    pub name: String,
20    /// Internal source name, used in URLs.
21    #[serde(rename = "slug")]
22    pub slug: String,
23    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
24    pub enabled: Option<bool>,
25    /// When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
26    #[serde(rename = "promoted", skip_serializing_if = "Option::is_none")]
27    pub promoted: Option<bool>,
28    /// Flow to use when authenticating existing users.
29    #[serde(
30        rename = "authentication_flow",
31        default,
32        with = "::serde_with::rust::double_option",
33        skip_serializing_if = "Option::is_none"
34    )]
35    pub authentication_flow: Option<Option<uuid::Uuid>>,
36    /// Flow to use when enrolling new users.
37    #[serde(
38        rename = "enrollment_flow",
39        default,
40        with = "::serde_with::rust::double_option",
41        skip_serializing_if = "Option::is_none"
42    )]
43    pub enrollment_flow: Option<Option<uuid::Uuid>>,
44    #[serde(rename = "user_property_mappings", skip_serializing_if = "Option::is_none")]
45    pub user_property_mappings: Option<Vec<uuid::Uuid>>,
46    #[serde(rename = "group_property_mappings", skip_serializing_if = "Option::is_none")]
47    pub group_property_mappings: Option<Vec<uuid::Uuid>>,
48    #[serde(rename = "policy_engine_mode", skip_serializing_if = "Option::is_none")]
49    pub policy_engine_mode: Option<models::PolicyEngineMode>,
50    /// How the source determines if an existing user should be authenticated or a new user enrolled.
51    #[serde(rename = "user_matching_mode", skip_serializing_if = "Option::is_none")]
52    pub user_matching_mode: Option<models::UserMatchingModeEnum>,
53    #[serde(rename = "user_path_template", skip_serializing_if = "Option::is_none")]
54    pub user_path_template: Option<String>,
55    #[serde(rename = "icon", skip_serializing_if = "Option::is_none")]
56    pub icon: Option<String>,
57    /// How the source determines if an existing group should be used or a new group created.
58    #[serde(rename = "group_matching_mode", skip_serializing_if = "Option::is_none")]
59    pub group_matching_mode: Option<models::GroupMatchingModeEnum>,
60    /// Kerberos realm
61    #[serde(rename = "realm")]
62    pub realm: String,
63    /// Custom krb5.conf to use. Uses the system one by default
64    #[serde(rename = "krb5_conf", skip_serializing_if = "Option::is_none")]
65    pub krb5_conf: Option<String>,
66    /// KAdmin server type
67    #[serde(rename = "kadmin_type", skip_serializing_if = "Option::is_none")]
68    pub kadmin_type: Option<models::KadminTypeEnum>,
69    /// Sync users from Kerberos into authentik
70    #[serde(rename = "sync_users", skip_serializing_if = "Option::is_none")]
71    pub sync_users: Option<bool>,
72    /// When a user changes their password, sync it back to Kerberos
73    #[serde(rename = "sync_users_password", skip_serializing_if = "Option::is_none")]
74    pub sync_users_password: Option<bool>,
75    /// Principal to authenticate to kadmin for sync.
76    #[serde(rename = "sync_principal", skip_serializing_if = "Option::is_none")]
77    pub sync_principal: Option<String>,
78    /// Password to authenticate to kadmin for sync
79    #[serde(rename = "sync_password", skip_serializing_if = "Option::is_none")]
80    pub sync_password: Option<String>,
81    /// Keytab to authenticate to kadmin for sync. Must be base64-encoded or in the form TYPE:residual
82    #[serde(rename = "sync_keytab", skip_serializing_if = "Option::is_none")]
83    pub sync_keytab: Option<String>,
84    /// Credentials cache to authenticate to kadmin for sync. Must be in the form TYPE:residual
85    #[serde(rename = "sync_ccache", skip_serializing_if = "Option::is_none")]
86    pub sync_ccache: Option<String>,
87    /// Force the use of a specific server name for SPNEGO. Must be in the form HTTP@hostname
88    #[serde(rename = "spnego_server_name", skip_serializing_if = "Option::is_none")]
89    pub spnego_server_name: Option<String>,
90    /// SPNEGO keytab base64-encoded or path to keytab in the form FILE:path
91    #[serde(rename = "spnego_keytab", skip_serializing_if = "Option::is_none")]
92    pub spnego_keytab: Option<String>,
93    /// Credential cache to use for SPNEGO in form type:residual
94    #[serde(rename = "spnego_ccache", skip_serializing_if = "Option::is_none")]
95    pub spnego_ccache: Option<String>,
96    /// If enabled, the authentik-stored password will be updated upon login with the Kerberos password backend
97    #[serde(
98        rename = "password_login_update_internal_password",
99        skip_serializing_if = "Option::is_none"
100    )]
101    pub password_login_update_internal_password: Option<bool>,
102    /// When to trigger sync for outgoing providers
103    #[serde(rename = "sync_outgoing_trigger_mode", skip_serializing_if = "Option::is_none")]
104    pub sync_outgoing_trigger_mode: Option<models::SyncOutgoingTriggerModeEnum>,
105}
106
107impl KerberosSourceRequest {
108    /// Kerberos Source Serializer
109    pub fn new(name: String, slug: String, realm: String) -> KerberosSourceRequest {
110        KerberosSourceRequest {
111            name,
112            slug,
113            enabled: None,
114            promoted: None,
115            authentication_flow: None,
116            enrollment_flow: None,
117            user_property_mappings: None,
118            group_property_mappings: None,
119            policy_engine_mode: None,
120            user_matching_mode: None,
121            user_path_template: None,
122            icon: None,
123            group_matching_mode: None,
124            realm,
125            krb5_conf: None,
126            kadmin_type: None,
127            sync_users: None,
128            sync_users_password: None,
129            sync_principal: None,
130            sync_password: None,
131            sync_keytab: None,
132            sync_ccache: None,
133            spnego_server_name: None,
134            spnego_keytab: None,
135            spnego_ccache: None,
136            password_login_update_internal_password: None,
137            sync_outgoing_trigger_mode: None,
138        }
139    }
140}