authentik_client/models/
saml_provider.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/// SamlProvider : SAMLProvider Serializer
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct SamlProvider {
17    #[serde(rename = "pk")]
18    pub pk: i32,
19    #[serde(rename = "name")]
20    pub name: String,
21    /// Flow used for authentication when the associated application is accessed by an un-authenticated user.
22    #[serde(
23        rename = "authentication_flow",
24        default,
25        with = "::serde_with::rust::double_option",
26        skip_serializing_if = "Option::is_none"
27    )]
28    pub authentication_flow: Option<Option<uuid::Uuid>>,
29    /// Flow used when authorizing this provider.
30    #[serde(rename = "authorization_flow")]
31    pub authorization_flow: uuid::Uuid,
32    /// Flow used ending the session from a provider.
33    #[serde(rename = "invalidation_flow")]
34    pub invalidation_flow: uuid::Uuid,
35    #[serde(rename = "property_mappings", skip_serializing_if = "Option::is_none")]
36    pub property_mappings: Option<Vec<uuid::Uuid>>,
37    /// Get object component so that we know how to edit the object
38    #[serde(rename = "component")]
39    pub component: String,
40    /// Internal application name, used in URLs.
41    #[serde(rename = "assigned_application_slug", deserialize_with = "Option::deserialize")]
42    pub assigned_application_slug: Option<String>,
43    /// Application's display Name.
44    #[serde(rename = "assigned_application_name", deserialize_with = "Option::deserialize")]
45    pub assigned_application_name: Option<String>,
46    /// Internal application name, used in URLs.
47    #[serde(
48        rename = "assigned_backchannel_application_slug",
49        deserialize_with = "Option::deserialize"
50    )]
51    pub assigned_backchannel_application_slug: Option<String>,
52    /// Application's display Name.
53    #[serde(
54        rename = "assigned_backchannel_application_name",
55        deserialize_with = "Option::deserialize"
56    )]
57    pub assigned_backchannel_application_name: Option<String>,
58    /// Return object's verbose_name
59    #[serde(rename = "verbose_name")]
60    pub verbose_name: String,
61    /// Return object's plural verbose_name
62    #[serde(rename = "verbose_name_plural")]
63    pub verbose_name_plural: String,
64    /// Return internal model name
65    #[serde(rename = "meta_model_name")]
66    pub meta_model_name: String,
67    #[serde(rename = "acs_url")]
68    pub acs_url: String,
69    /// Single Logout Service URL where the logout response should be sent.
70    #[serde(rename = "sls_url", skip_serializing_if = "Option::is_none")]
71    pub sls_url: Option<String>,
72    /// Value of the audience restriction field of the assertion. When left empty, no audience restriction will be added.
73    #[serde(rename = "audience", skip_serializing_if = "Option::is_none")]
74    pub audience: Option<String>,
75    /// Also known as EntityID
76    #[serde(rename = "issuer", skip_serializing_if = "Option::is_none")]
77    pub issuer: Option<String>,
78    /// Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).
79    #[serde(rename = "assertion_valid_not_before", skip_serializing_if = "Option::is_none")]
80    pub assertion_valid_not_before: Option<String>,
81    /// Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
82    #[serde(rename = "assertion_valid_not_on_or_after", skip_serializing_if = "Option::is_none")]
83    pub assertion_valid_not_on_or_after: Option<String>,
84    /// Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
85    #[serde(rename = "session_valid_not_on_or_after", skip_serializing_if = "Option::is_none")]
86    pub session_valid_not_on_or_after: Option<String>,
87    /// Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered
88    #[serde(
89        rename = "name_id_mapping",
90        default,
91        with = "::serde_with::rust::double_option",
92        skip_serializing_if = "Option::is_none"
93    )]
94    pub name_id_mapping: Option<Option<uuid::Uuid>>,
95    /// Configure how the AuthnContextClassRef value will be created. When left empty, the AuthnContextClassRef will be set based on which authentication methods the user used to authenticate.
96    #[serde(
97        rename = "authn_context_class_ref_mapping",
98        default,
99        with = "::serde_with::rust::double_option",
100        skip_serializing_if = "Option::is_none"
101    )]
102    pub authn_context_class_ref_mapping: Option<Option<uuid::Uuid>>,
103    #[serde(rename = "digest_algorithm", skip_serializing_if = "Option::is_none")]
104    pub digest_algorithm: Option<models::DigestAlgorithmEnum>,
105    #[serde(rename = "signature_algorithm", skip_serializing_if = "Option::is_none")]
106    pub signature_algorithm: Option<models::SignatureAlgorithmEnum>,
107    /// Keypair used to sign outgoing Responses going to the Service Provider.
108    #[serde(
109        rename = "signing_kp",
110        default,
111        with = "::serde_with::rust::double_option",
112        skip_serializing_if = "Option::is_none"
113    )]
114    pub signing_kp: Option<Option<uuid::Uuid>>,
115    /// When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default.
116    #[serde(
117        rename = "verification_kp",
118        default,
119        with = "::serde_with::rust::double_option",
120        skip_serializing_if = "Option::is_none"
121    )]
122    pub verification_kp: Option<Option<uuid::Uuid>>,
123    /// When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key.
124    #[serde(
125        rename = "encryption_kp",
126        default,
127        with = "::serde_with::rust::double_option",
128        skip_serializing_if = "Option::is_none"
129    )]
130    pub encryption_kp: Option<Option<uuid::Uuid>>,
131    #[serde(rename = "sign_assertion", skip_serializing_if = "Option::is_none")]
132    pub sign_assertion: Option<bool>,
133    #[serde(rename = "sign_response", skip_serializing_if = "Option::is_none")]
134    pub sign_response: Option<bool>,
135    #[serde(rename = "sign_logout_request", skip_serializing_if = "Option::is_none")]
136    pub sign_logout_request: Option<bool>,
137    /// This determines how authentik sends the response back to the Service Provider.
138    #[serde(rename = "sp_binding", skip_serializing_if = "Option::is_none")]
139    pub sp_binding: Option<models::SamlBindingsEnum>,
140    /// This determines how authentik sends the logout response back to the Service Provider.
141    #[serde(rename = "sls_binding", skip_serializing_if = "Option::is_none")]
142    pub sls_binding: Option<models::SamlBindingsEnum>,
143    /// Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).
144    #[serde(rename = "logout_method", skip_serializing_if = "Option::is_none")]
145    pub logout_method: Option<models::SamlLogoutMethods>,
146    /// Default relay_state value for IDP-initiated logins
147    #[serde(rename = "default_relay_state", skip_serializing_if = "Option::is_none")]
148    pub default_relay_state: Option<String>,
149    #[serde(rename = "default_name_id_policy", skip_serializing_if = "Option::is_none")]
150    pub default_name_id_policy: Option<models::SamlNameIdPolicyEnum>,
151    /// Get metadata download URL
152    #[serde(rename = "url_download_metadata")]
153    pub url_download_metadata: String,
154    /// Get SSO Post URL
155    #[serde(rename = "url_sso_post")]
156    pub url_sso_post: String,
157    /// Get SSO Redirect URL
158    #[serde(rename = "url_sso_redirect")]
159    pub url_sso_redirect: String,
160    /// Get SSO IDP-Initiated URL
161    #[serde(rename = "url_sso_init")]
162    pub url_sso_init: String,
163    /// Get SLO POST URL
164    #[serde(rename = "url_slo_post")]
165    pub url_slo_post: String,
166    /// Get SLO redirect URL
167    #[serde(rename = "url_slo_redirect")]
168    pub url_slo_redirect: String,
169}
170
171impl SamlProvider {
172    /// SAMLProvider Serializer
173    pub fn new(
174        pk: i32,
175        name: String,
176        authorization_flow: uuid::Uuid,
177        invalidation_flow: uuid::Uuid,
178        component: String,
179        assigned_application_slug: Option<String>,
180        assigned_application_name: Option<String>,
181        assigned_backchannel_application_slug: Option<String>,
182        assigned_backchannel_application_name: Option<String>,
183        verbose_name: String,
184        verbose_name_plural: String,
185        meta_model_name: String,
186        acs_url: String,
187        url_download_metadata: String,
188        url_sso_post: String,
189        url_sso_redirect: String,
190        url_sso_init: String,
191        url_slo_post: String,
192        url_slo_redirect: String,
193    ) -> SamlProvider {
194        SamlProvider {
195            pk,
196            name,
197            authentication_flow: None,
198            authorization_flow,
199            invalidation_flow,
200            property_mappings: None,
201            component,
202            assigned_application_slug,
203            assigned_application_name,
204            assigned_backchannel_application_slug,
205            assigned_backchannel_application_name,
206            verbose_name,
207            verbose_name_plural,
208            meta_model_name,
209            acs_url,
210            sls_url: None,
211            audience: None,
212            issuer: None,
213            assertion_valid_not_before: None,
214            assertion_valid_not_on_or_after: None,
215            session_valid_not_on_or_after: None,
216            name_id_mapping: None,
217            authn_context_class_ref_mapping: None,
218            digest_algorithm: None,
219            signature_algorithm: None,
220            signing_kp: None,
221            verification_kp: None,
222            encryption_kp: None,
223            sign_assertion: None,
224            sign_response: None,
225            sign_logout_request: None,
226            sp_binding: None,
227            sls_binding: None,
228            logout_method: None,
229            default_relay_state: None,
230            default_name_id_policy: None,
231            url_download_metadata,
232            url_sso_post,
233            url_sso_redirect,
234            url_sso_init,
235            url_slo_post,
236            url_slo_redirect,
237        }
238    }
239}
authentik_client/models/saml_provider.rs

authentik_client/models/
saml_provider.rs
