kanidmd_core/https/apidocs/
mod.rs

Help
1use axum::{middleware::from_fn, response::Redirect, routing::get, Router};
2use kanidm_proto::{attribute, internal, scim_v1, v1};
3use utoipa::{
4    openapi::security::{HttpAuthScheme, HttpBuilder, SecurityScheme},
5    Modify, OpenApi,
6};
7use utoipa_swagger_ui::SwaggerUi;
8
9use super::{errors::WebError, ServerState};
10
11pub(crate) mod path_schema;
12pub(crate) mod response_schema;
13#[cfg(test)]
14pub(crate) mod tests;
15
16struct SecurityAddon;
17
18impl Modify for SecurityAddon {
19    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
20        if let Some(components) = openapi.components.as_mut() {
21            components.add_security_scheme(
22                "token_jwt",
23                SecurityScheme::Http(
24                    HttpBuilder::new()
25                        .scheme(HttpAuthScheme::Bearer)
26                        .bearer_format("JWT")
27                        .build(),
28                ),
29            )
30        }
31    }
32}
33
34// docs for the derive macro are here: <https://docs.rs/utoipa-gen/3.5.0/utoipa_gen/derive.OpenApi.html#info-attribute-syntax>
35#[derive(OpenApi)]
36#[openapi(
37    servers(
38        (url="https://{host}:{port}",
39            variables(
40                ("host" = (default="localhost", description="Server's hostname")),
41                ("port" = (default="8443", description="Server HTTPS port")),
42            )
43        )
44    ),
45    external_docs(url = "https://kanidm.com/docs", description = "Kanidm documentation page"),
46
47    paths(
48        super::generic::status,
49        super::generic::robots_txt,
50
51        super::oauth2::oauth2_image_get,
52
53        super::v1::raw_create,
54        super::v1::raw_delete,
55        super::v1::raw_modify,
56        super::v1::raw_search,
57
58        super::v1_oauth2::oauth2_id_image_delete,
59        super::v1_oauth2::oauth2_id_image_post,
60        super::v1_oauth2::oauth2_get,
61        super::v1_oauth2::oauth2_basic_post,
62        super::v1_oauth2::oauth2_public_post,
63        super::v1_oauth2::oauth2_id_get,
64        super::v1_oauth2::oauth2_id_patch,
65        super::v1_oauth2::oauth2_id_delete,
66        super::v1_oauth2::oauth2_id_image_post,
67        super::v1_oauth2::oauth2_id_image_delete,
68        super::v1_oauth2::oauth2_id_get_basic_secret,
69        super::v1_oauth2::oauth2_id_scopemap_post,
70        super::v1_oauth2::oauth2_id_scopemap_delete,
71        super::v1_oauth2::oauth2_id_sup_scopemap_post,
72        super::v1_oauth2::oauth2_id_sup_scopemap_delete,
73        super::v1_oauth2::oauth2_id_claimmap_join_post,
74        super::v1_oauth2::oauth2_id_claimmap_post,
75        super::v1_oauth2::oauth2_id_claimmap_delete,
76
77        super::v1_scim::scim_sync_post,
78        super::v1_scim::scim_sync_get,
79        super::v1_scim::scim_entry_id_get,
80        super::v1_scim::scim_person_id_get,
81        super::v1_scim::scim_application_get,
82        super::v1_scim::scim_application_post,
83        super::v1_scim::scim_application_id_delete,
84
85        super::v1::schema_get,
86        super::v1::whoami,
87        super::v1::whoami_uat,
88        super::v1::applinks_get,
89        super::v1::schema_attributetype_get,
90        super::v1::schema_attributetype_get_id,
91        super::v1::schema_classtype_get,
92        super::v1::schema_classtype_get_id,
93        super::v1::person_get,
94        super::v1::person_post,
95        super::v1::service_account_credential_generate,
96        super::v1::service_account_api_token_delete,
97        super::v1::service_account_api_token_get,
98        super::v1::service_account_api_token_post,
99        super::v1::person_search_id,
100        super::v1::person_id_get,
101        super::v1::person_id_patch,
102        super::v1::person_id_delete,
103        super::v1::person_id_get_attr,
104        super::v1::person_id_put_attr,
105        super::v1::person_id_post_attr,
106        super::v1::person_id_delete_attr,
107        super::v1::person_get_id_certificate,
108        super::v1::person_post_id_certificate,
109        super::v1::person_get_id_credential_status,
110        super::v1::person_id_credential_update_get,
111        super::v1::person_id_credential_update_intent_get,
112        super::v1::person_id_credential_update_intent_ttl_get,
113
114        super::v1::service_account_id_ssh_pubkeys_get,
115        super::v1::service_account_id_ssh_pubkeys_post,
116
117        super::v1::person_id_ssh_pubkeys_get,
118        super::v1::person_id_ssh_pubkeys_post,
119        super::v1::person_id_ssh_pubkeys_tag_get,
120        super::v1::person_id_ssh_pubkeys_tag_delete,
121
122        super::v1::person_id_radius_get,
123        super::v1::person_id_radius_post,
124        super::v1::person_id_radius_delete,
125        super::v1::person_id_radius_token_get,
126
127        super::v1::account_id_ssh_pubkeys_get,
128        super::v1::account_id_radius_token_post,
129        super::v1::person_id_unix_post,
130        super::v1::person_id_unix_credential_put,
131        super::v1::person_id_unix_credential_delete,
132        super::v1::person_identify_user_post,
133        super::v1::service_account_get,
134        super::v1::service_account_post,
135        super::v1::service_account_get,
136        super::v1::service_account_post,
137        super::v1::service_account_id_get,
138        super::v1::service_account_id_delete,
139        super::v1::service_account_id_patch,
140        super::v1::service_account_id_get_attr,
141        super::v1::service_account_id_put_attr,
142        super::v1::service_account_id_post_attr,
143        super::v1::service_account_id_delete_attr,
144        super::v1::service_account_into_person,
145        super::v1::service_account_api_token_post,
146        super::v1::service_account_api_token_get,
147        super::v1::service_account_api_token_delete,
148        super::v1::service_account_credential_generate,
149        super::v1::service_account_id_credential_status_get,
150        super::v1::service_account_id_ssh_pubkeys_tag_get,
151        super::v1::service_account_id_ssh_pubkeys_tag_delete,
152        super::v1::service_account_id_unix_post,
153        super::v1::account_id_unix_auth_post,
154        super::v1::account_id_unix_token,
155        super::v1::account_id_unix_token,
156        super::v1::account_id_radius_token_post,
157        super::v1::account_id_radius_token_get,
158        super::v1::account_id_ssh_pubkeys_get,
159        super::v1::account_id_ssh_pubkeys_tag_get,
160        super::v1::account_id_user_auth_token_get,
161        super::v1::account_user_auth_token_delete,
162        super::v1::credential_update_exchange_intent,
163        super::v1::credential_update_status,
164        super::v1::credential_update_update,
165        super::v1::credential_update_commit,
166        super::v1::credential_update_cancel,
167        super::v1::domain_get,
168        super::v1::domain_attr_get,
169        super::v1::domain_attr_put,
170        super::v1::domain_attr_delete,
171        super::v1_domain::image_post,
172        super::v1_domain::image_delete,
173
174        super::v1::group_id_unix_token_get,
175        super::v1::group_id_unix_post,
176        super::v1::group_get,
177        super::v1::group_post,
178        super::v1::group_search_id,
179        super::v1::group_id_get,
180        super::v1::group_id_patch,
181        super::v1::group_id_delete,
182        super::v1::group_id_attr_delete,
183        super::v1::group_id_attr_get,
184        super::v1::group_id_attr_put,
185        super::v1::group_id_attr_post,
186        super::v1::system_get,
187        super::v1::system_attr_get,
188        super::v1::system_attr_post,
189        super::v1::system_attr_put,
190        super::v1::system_attr_delete,
191        super::v1::recycle_bin_get,
192        super::v1::recycle_bin_id_get,
193        super::v1::recycle_bin_revive_id_post,
194        super::v1::auth,
195        super::v1::auth_valid,
196        super::v1::logout,
197        super::v1::reauth,
198        super::v1_scim::sync_account_get,
199        super::v1_scim::sync_account_post,
200        super::v1_scim::sync_account_id_get,
201        super::v1_scim::sync_account_id_patch,
202        super::v1_scim::sync_account_id_attr_get,
203        super::v1_scim::sync_account_id_attr_put,
204        super::v1_scim::sync_account_id_finalise_get,
205        super::v1_scim::sync_account_id_terminate_get,
206        super::v1_scim::sync_account_token_post,
207        super::v1_scim::sync_account_token_delete,
208        super::v1::debug_ipinfo,
209        super::v1::public_jwk_key_id_get,
210
211    ),
212    components(
213        schemas(
214            attribute::Attribute,
215
216            scim_v1::ScimSyncState,
217            scim_v1::ScimSyncRequest,
218            scim_v1::ScimSyncRetentionMode,
219            scim_v1::ScimEntry,
220            scim_v1::ScimValue,
221            scim_v1::ScimMeta,
222            scim_v1::ScimAttr,
223            scim_v1::client::ScimEntryPostGeneric,
224
225            internal::ApiToken,
226            internal::ApiTokenPurpose,
227            internal::BackupCodesView,
228            internal::ConsistencyError,
229            internal::CreateRequest,
230            internal::CredentialDetail,
231            internal::CredentialDetailType,
232            internal::CredentialStatus,
233            internal::CUExtPortal,
234            internal::CUIntentToken,
235            internal::CURegState,
236            internal::CUSessionToken,
237            internal::CUStatus,
238            internal::DeleteRequest,
239            internal::Filter,
240            internal::Group,
241            internal::Modify,
242            internal::ModifyList,
243            internal::ModifyRequest,
244            internal::Oauth2ClaimMapJoin,
245            internal::OperationError,
246            internal::PasskeyDetail,
247            internal::PasswordFeedback,
248            internal::PluginError,
249            internal::RadiusAuthToken,
250            internal::SchemaError,
251            internal::SearchRequest,
252            internal::SearchResponse,
253            internal::TotpAlgo,
254            internal::TotpSecret,
255            internal::UatPurpose,
256            internal::UserAuthToken,
257            v1::AccountUnixExtend,
258            v1::ApiTokenGenerate,
259            v1::AuthAllowed,
260            v1::AuthCredential,
261            v1::AuthIssueSession,
262            v1::AuthMech,
263            v1::AuthRequest,
264            v1::AuthResponse,
265            v1::AuthState,
266            v1::AuthStep,
267            v1::Entry,
268            v1::GroupUnixExtend,
269            v1::PublicKeyKindSchema,
270            v1::SingleStringRequest,
271            v1::SshPublicKeySchema,
272            v1::KeyTypeKindSchema,
273            v1::KeyTypeSchema,
274            internal::UiHint,
275            v1::UatPurposeStatus,
276            v1::UatStatus,
277            v1::UatStatusState,
278            v1::UnixGroupToken,
279            v1::UnixUserToken,
280            v1::WhoamiResponse,
281            internal::CUCredState,
282            internal::CURegWarning,
283            internal::IdentifyUserResponse,
284            internal::AppLink,
285
286            internal::IdentifyUserRequest,
287            // terrible workaround for other things
288            response_schema::CreationChallengeResponse,
289
290            // terrible workaround for other things
291            response_schema::PublicKeyCredential,
292            // terrible workaround for other things
293            response_schema::RequestChallengeResponse,
294            // terrible workaround for other things
295            response_schema::Base64UrlSafeData,
296            // terrible workaround for other things
297            response_schema::BTreeSet,
298            // terrible workaround for other things
299            response_schema::Result,
300            // terrible workaround for other things
301            response_schema::ScimEntry,
302            //  workaround for the fact that BTreeSet can't be represented in JSON
303            response_schema::ProtoEntry,
304            // terrible workaround for other things
305            response_schema::Jwk,
306            response_schema::ScimComplexAttr,
307            WebError,
308        )
309    ),
310    modifiers(&SecurityAddon),
311    tags(
312        (name = "kanidm", description = "Kanidm API")
313    ),
314    info(
315        title = "Kanidm",
316        description = "API for interacting with the Kanidm system. This is a work in progress.",
317        contact( // <https://docs.rs/utoipa-gen/3.5.0/utoipa_gen/derive.OpenApi.html#info-attribute-syntax>
318            name="Kanidm Github",
319            url="https://github.com/kanidm/kanidm",
320        )
321    )
322)]
323pub(crate) struct ApiDoc;
324
325pub(crate) fn router() -> Router<ServerState> {
326    Router::new()
327        .route("/docs", get(Redirect::temporary("/docs/swagger-ui")))
328        .route("/docs/", get(Redirect::temporary("/docs/swagger-ui")))
329        .merge(SwaggerUi::new("/docs/swagger-ui").url("/docs/v1/openapi.json", ApiDoc::openapi()))
330        // overlay the version middleware because the client is sad without it
331        .layer(from_fn(super::middleware::version_middleware))
332}
kanidmd_core/https/apidocs/mod.rs

kanidmd_core/https/apidocs/
mod.rs
