authentik_client/models/
saml_provider.rs

1/*
2 * authentik
3 *
4 * Making authentication simple.
5 *
6 * The version of the OpenAPI document: 2025.10.2
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")]
42    pub assigned_application_slug: String,
43    /// Application's display Name.
44    #[serde(rename = "assigned_application_name")]
45    pub assigned_application_name: String,
46    /// Internal application name, used in URLs.
47    #[serde(rename = "assigned_backchannel_application_slug")]
48    pub assigned_backchannel_application_slug: String,
49    /// Application's display Name.
50    #[serde(rename = "assigned_backchannel_application_name")]
51    pub assigned_backchannel_application_name: String,
52    /// Return object's verbose_name
53    #[serde(rename = "verbose_name")]
54    pub verbose_name: String,
55    /// Return object's plural verbose_name
56    #[serde(rename = "verbose_name_plural")]
57    pub verbose_name_plural: String,
58    /// Return internal model name
59    #[serde(rename = "meta_model_name")]
60    pub meta_model_name: String,
61    #[serde(rename = "acs_url")]
62    pub acs_url: String,
63    /// Single Logout Service URL where the logout response should be sent.
64    #[serde(rename = "sls_url", skip_serializing_if = "Option::is_none")]
65    pub sls_url: Option<String>,
66    /// Value of the audience restriction field of the assertion. When left empty, no audience restriction will be added.
67    #[serde(rename = "audience", skip_serializing_if = "Option::is_none")]
68    pub audience: Option<String>,
69    /// Also known as EntityID
70    #[serde(rename = "issuer", skip_serializing_if = "Option::is_none")]
71    pub issuer: Option<String>,
72    /// Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).
73    #[serde(rename = "assertion_valid_not_before", skip_serializing_if = "Option::is_none")]
74    pub assertion_valid_not_before: Option<String>,
75    /// Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
76    #[serde(rename = "assertion_valid_not_on_or_after", skip_serializing_if = "Option::is_none")]
77    pub assertion_valid_not_on_or_after: Option<String>,
78    /// Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).
79    #[serde(rename = "session_valid_not_on_or_after", skip_serializing_if = "Option::is_none")]
80    pub session_valid_not_on_or_after: Option<String>,
81    /// Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered
82    #[serde(
83        rename = "name_id_mapping",
84        default,
85        with = "::serde_with::rust::double_option",
86        skip_serializing_if = "Option::is_none"
87    )]
88    pub name_id_mapping: Option<Option<uuid::Uuid>>,
89    /// 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.
90    #[serde(
91        rename = "authn_context_class_ref_mapping",
92        default,
93        with = "::serde_with::rust::double_option",
94        skip_serializing_if = "Option::is_none"
95    )]
96    pub authn_context_class_ref_mapping: Option<Option<uuid::Uuid>>,
97    #[serde(rename = "digest_algorithm", skip_serializing_if = "Option::is_none")]
98    pub digest_algorithm: Option<models::DigestAlgorithmEnum>,
99    #[serde(rename = "signature_algorithm", skip_serializing_if = "Option::is_none")]
100    pub signature_algorithm: Option<models::SignatureAlgorithmEnum>,
101    /// Keypair used to sign outgoing Responses going to the Service Provider.
102    #[serde(
103        rename = "signing_kp",
104        default,
105        with = "::serde_with::rust::double_option",
106        skip_serializing_if = "Option::is_none"
107    )]
108    pub signing_kp: Option<Option<uuid::Uuid>>,
109    /// When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default.
110    #[serde(
111        rename = "verification_kp",
112        default,
113        with = "::serde_with::rust::double_option",
114        skip_serializing_if = "Option::is_none"
115    )]
116    pub verification_kp: Option<Option<uuid::Uuid>>,
117    /// 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.
118    #[serde(
119        rename = "encryption_kp",
120        default,
121        with = "::serde_with::rust::double_option",
122        skip_serializing_if = "Option::is_none"
123    )]
124    pub encryption_kp: Option<Option<uuid::Uuid>>,
125    #[serde(rename = "sign_assertion", skip_serializing_if = "Option::is_none")]
126    pub sign_assertion: Option<bool>,
127    #[serde(rename = "sign_response", skip_serializing_if = "Option::is_none")]
128    pub sign_response: Option<bool>,
129    #[serde(rename = "sign_logout_request", skip_serializing_if = "Option::is_none")]
130    pub sign_logout_request: Option<bool>,
131    /// This determines how authentik sends the response back to the Service Provider.
132    #[serde(rename = "sp_binding", skip_serializing_if = "Option::is_none")]
133    pub sp_binding: Option<models::SamlBindingsEnum>,
134    /// This determines how authentik sends the logout response back to the Service Provider.
135    #[serde(rename = "sls_binding", skip_serializing_if = "Option::is_none")]
136    pub sls_binding: Option<models::SamlBindingsEnum>,
137    /// 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).
138    #[serde(rename = "logout_method", skip_serializing_if = "Option::is_none")]
139    pub logout_method: Option<models::SamlProviderLogoutMethodEnum>,
140    /// Default relay_state value for IDP-initiated logins
141    #[serde(rename = "default_relay_state", skip_serializing_if = "Option::is_none")]
142    pub default_relay_state: Option<String>,
143    #[serde(rename = "default_name_id_policy", skip_serializing_if = "Option::is_none")]
144    pub default_name_id_policy: Option<models::SamlNameIdPolicyEnum>,
145    /// Get metadata download URL
146    #[serde(rename = "url_download_metadata")]
147    pub url_download_metadata: String,
148    /// Get SSO Post URL
149    #[serde(rename = "url_sso_post")]
150    pub url_sso_post: String,
151    /// Get SSO Redirect URL
152    #[serde(rename = "url_sso_redirect")]
153    pub url_sso_redirect: String,
154    /// Get SSO IDP-Initiated URL
155    #[serde(rename = "url_sso_init")]
156    pub url_sso_init: String,
157    /// Get SLO POST URL
158    #[serde(rename = "url_slo_post")]
159    pub url_slo_post: String,
160    /// Get SLO redirect URL
161    #[serde(rename = "url_slo_redirect")]
162    pub url_slo_redirect: String,
163}
164
165impl SamlProvider {
166    /// SAMLProvider Serializer
167    pub fn new(
168        pk: i32,
169        name: String,
170        authorization_flow: uuid::Uuid,
171        invalidation_flow: uuid::Uuid,
172        component: String,
173        assigned_application_slug: String,
174        assigned_application_name: String,
175        assigned_backchannel_application_slug: String,
176        assigned_backchannel_application_name: String,
177        verbose_name: String,
178        verbose_name_plural: String,
179        meta_model_name: String,
180        acs_url: String,
181        url_download_metadata: String,
182        url_sso_post: String,
183        url_sso_redirect: String,
184        url_sso_init: String,
185        url_slo_post: String,
186        url_slo_redirect: String,
187    ) -> SamlProvider {
188        SamlProvider {
189            pk,
190            name,
191            authentication_flow: None,
192            authorization_flow,
193            invalidation_flow,
194            property_mappings: None,
195            component,
196            assigned_application_slug,
197            assigned_application_name,
198            assigned_backchannel_application_slug,
199            assigned_backchannel_application_name,
200            verbose_name,
201            verbose_name_plural,
202            meta_model_name,
203            acs_url,
204            sls_url: None,
205            audience: None,
206            issuer: None,
207            assertion_valid_not_before: None,
208            assertion_valid_not_on_or_after: None,
209            session_valid_not_on_or_after: None,
210            name_id_mapping: None,
211            authn_context_class_ref_mapping: None,
212            digest_algorithm: None,
213            signature_algorithm: None,
214            signing_kp: None,
215            verification_kp: None,
216            encryption_kp: None,
217            sign_assertion: None,
218            sign_response: None,
219            sign_logout_request: None,
220            sp_binding: None,
221            sls_binding: None,
222            logout_method: None,
223            default_relay_state: None,
224            default_name_id_policy: None,
225            url_download_metadata,
226            url_sso_post,
227            url_sso_redirect,
228            url_sso_init,
229            url_slo_post,
230            url_slo_redirect,
231        }
232    }
233}
authentik_client/models/saml_provider.rs

authentik_client/models/
saml_provider.rs
