ruma_client_api/
session.rs

1//! Endpoints for user session management.
2
3#[cfg(feature = "unstable-msc3824")]
4use ruma_common::serde::StringEnum;
5
6#[cfg(feature = "unstable-msc3824")]
7use crate::PrivOwnedStr;
8
9pub mod get_login_token;
10pub mod get_login_types;
11pub mod login;
12pub mod login_fallback;
13pub mod logout;
14pub mod logout_all;
15pub mod refresh_token;
16pub mod sso_login;
17pub mod sso_login_with_provider;
18
19/// Possible purposes for using the SSO redirect URL for OIDC-aware compatibility ([MSC3824]).
20///
21/// [MSC3824]: https://github.com/matrix-org/matrix-spec-proposals/pull/3824
22#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
23#[derive(Clone, StringEnum)]
24#[ruma_enum(rename_all = "lowercase")]
25#[non_exhaustive]
26#[cfg(feature = "unstable-msc3824")]
27pub enum SsoRedirectOidcAction {
28    /// The SSO redirect is for the purpose of signing an existing user in.
29    Login,
30
31    /// The SSO redirect is for the purpose of registering a new user account.
32    Register,
33
34    #[doc(hidden)]
35    _Custom(PrivOwnedStr),
36}