authentik_client/models/
o_auth_source_request.rs

1/*
2 * authentik
3 *
4 * Making authentication simple.
5 *
6 * The version of the OpenAPI document: 2025.8.6
7 * Contact: hello@goauthentik.io
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// OAuthSourceRequest : OAuth Source Serializer
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct OAuthSourceRequest {
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    /// Flow to use when authenticating existing users.
26    #[serde(
27        rename = "authentication_flow",
28        default,
29        with = "::serde_with::rust::double_option",
30        skip_serializing_if = "Option::is_none"
31    )]
32    pub authentication_flow: Option<Option<uuid::Uuid>>,
33    /// Flow to use when enrolling new users.
34    #[serde(
35        rename = "enrollment_flow",
36        default,
37        with = "::serde_with::rust::double_option",
38        skip_serializing_if = "Option::is_none"
39    )]
40    pub enrollment_flow: Option<Option<uuid::Uuid>>,
41    #[serde(rename = "user_property_mappings", skip_serializing_if = "Option::is_none")]
42    pub user_property_mappings: Option<Vec<uuid::Uuid>>,
43    #[serde(rename = "group_property_mappings", skip_serializing_if = "Option::is_none")]
44    pub group_property_mappings: Option<Vec<uuid::Uuid>>,
45    #[serde(rename = "policy_engine_mode", skip_serializing_if = "Option::is_none")]
46    pub policy_engine_mode: Option<models::PolicyEngineMode>,
47    /// How the source determines if an existing user should be authenticated or a new user enrolled.
48    #[serde(rename = "user_matching_mode", skip_serializing_if = "Option::is_none")]
49    pub user_matching_mode: Option<models::UserMatchingModeEnum>,
50    #[serde(rename = "user_path_template", skip_serializing_if = "Option::is_none")]
51    pub user_path_template: Option<String>,
52    /// How the source determines if an existing group should be used or a new group created.
53    #[serde(rename = "group_matching_mode", skip_serializing_if = "Option::is_none")]
54    pub group_matching_mode: Option<models::GroupMatchingModeEnum>,
55    #[serde(rename = "provider_type")]
56    pub provider_type: models::ProviderTypeEnum,
57    /// URL used to request the initial token. This URL is only required for OAuth 1.
58    #[serde(
59        rename = "request_token_url",
60        default,
61        with = "::serde_with::rust::double_option",
62        skip_serializing_if = "Option::is_none"
63    )]
64    pub request_token_url: Option<Option<String>>,
65    /// URL the user is redirect to to conest the flow.
66    #[serde(
67        rename = "authorization_url",
68        default,
69        with = "::serde_with::rust::double_option",
70        skip_serializing_if = "Option::is_none"
71    )]
72    pub authorization_url: Option<Option<String>>,
73    /// URL used by authentik to retrieve tokens.
74    #[serde(
75        rename = "access_token_url",
76        default,
77        with = "::serde_with::rust::double_option",
78        skip_serializing_if = "Option::is_none"
79    )]
80    pub access_token_url: Option<Option<String>>,
81    /// URL used by authentik to get user information.
82    #[serde(
83        rename = "profile_url",
84        default,
85        with = "::serde_with::rust::double_option",
86        skip_serializing_if = "Option::is_none"
87    )]
88    pub profile_url: Option<Option<String>>,
89    #[serde(rename = "consumer_key")]
90    pub consumer_key: String,
91    #[serde(rename = "consumer_secret")]
92    pub consumer_secret: String,
93    #[serde(rename = "additional_scopes", skip_serializing_if = "Option::is_none")]
94    pub additional_scopes: Option<String>,
95    #[serde(rename = "oidc_well_known_url", skip_serializing_if = "Option::is_none")]
96    pub oidc_well_known_url: Option<String>,
97    #[serde(rename = "oidc_jwks_url", skip_serializing_if = "Option::is_none")]
98    pub oidc_jwks_url: Option<String>,
99    #[serde(rename = "oidc_jwks", skip_serializing_if = "Option::is_none")]
100    pub oidc_jwks: Option<std::collections::HashMap<String, serde_json::Value>>,
101    /// How to perform authentication during an authorization_code token request flow
102    #[serde(rename = "authorization_code_auth_method", skip_serializing_if = "Option::is_none")]
103    pub authorization_code_auth_method: Option<models::AuthorizationCodeAuthMethodEnum>,
104}
105
106impl OAuthSourceRequest {
107    /// OAuth Source Serializer
108    pub fn new(
109        name: String,
110        slug: String,
111        provider_type: models::ProviderTypeEnum,
112        consumer_key: String,
113        consumer_secret: String,
114    ) -> OAuthSourceRequest {
115        OAuthSourceRequest {
116            name,
117            slug,
118            enabled: None,
119            authentication_flow: None,
120            enrollment_flow: None,
121            user_property_mappings: None,
122            group_property_mappings: None,
123            policy_engine_mode: None,
124            user_matching_mode: None,
125            user_path_template: None,
126            group_matching_mode: None,
127            provider_type,
128            request_token_url: None,
129            authorization_url: None,
130            access_token_url: None,
131            profile_url: None,
132            consumer_key,
133            consumer_secret,
134            additional_scopes: None,
135            oidc_well_known_url: None,
136            oidc_jwks_url: None,
137            oidc_jwks: None,
138            authorization_code_auth_method: None,
139        }
140    }
141}
authentik_client/models/o_auth_source_request.rs

authentik_client/models/
o_auth_source_request.rs
