clerk_sdk_rust_community/apis/
sessions_api.rs

1/*
2 * Clerk Backend API
3 *
4 * The Clerk REST Backend API, meant to be accessed by backend servers. Please see https://clerk.com/docs for more information.
5 *
6 * The version of the OpenAPI document: v1
7 * Contact: support@clerk.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13
14use crate::apis::ResponseContent;
15use super::{Error, configuration};
16
17
18/// struct for typed errors of method [`create_session_token_from_template`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum CreateSessionTokenFromTemplateError {
22    Status401(crate::models::ClerkErrors),
23    Status404(crate::models::ClerkErrors),
24    UnknownValue(serde_json::Value),
25}
26
27/// struct for typed errors of method [`get_session`]
28#[derive(Debug, Clone, Serialize, Deserialize)]
29#[serde(untagged)]
30pub enum GetSessionError {
31    Status400(crate::models::ClerkErrors),
32    Status401(crate::models::ClerkErrors),
33    Status404(crate::models::ClerkErrors),
34    UnknownValue(serde_json::Value),
35}
36
37/// struct for typed errors of method [`get_session_list`]
38#[derive(Debug, Clone, Serialize, Deserialize)]
39#[serde(untagged)]
40pub enum GetSessionListError {
41    Status400(crate::models::ClerkErrors),
42    Status401(crate::models::ClerkErrors),
43    Status422(crate::models::ClerkErrors),
44    UnknownValue(serde_json::Value),
45}
46
47/// struct for typed errors of method [`revoke_session`]
48#[derive(Debug, Clone, Serialize, Deserialize)]
49#[serde(untagged)]
50pub enum RevokeSessionError {
51    Status400(crate::models::ClerkErrors),
52    Status401(crate::models::ClerkErrors),
53    Status404(crate::models::ClerkErrors),
54    UnknownValue(serde_json::Value),
55}
56
57/// struct for typed errors of method [`verify_session`]
58#[derive(Debug, Clone, Serialize, Deserialize)]
59#[serde(untagged)]
60pub enum VerifySessionError {
61    Status400(crate::models::ClerkErrors),
62    Status401(crate::models::ClerkErrors),
63    Status404(crate::models::ClerkErrors),
64    UnknownValue(serde_json::Value),
65}
66
67
68/// Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined for your instance
69pub async fn create_session_token_from_template(configuration: &configuration::Configuration, session_id: &str, template_name: &str) -> Result<crate::models::CreateSessionTokenFromTemplate200Response, Error<CreateSessionTokenFromTemplateError>> {
70    let local_var_configuration = configuration;
71
72    let local_var_client = &local_var_configuration.client;
73
74    let local_var_uri_str = format!("{}/sessions/{session_id}/tokens/{template_name}", local_var_configuration.base_path, session_id=crate::apis::urlencode(session_id), template_name=crate::apis::urlencode(template_name));
75    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
76
77    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
78        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
79    }
80    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
81        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
82    };
83
84    let local_var_req = local_var_req_builder.build()?;
85    let local_var_resp = local_var_client.execute(local_var_req).await?;
86
87    let local_var_status = local_var_resp.status();
88    let local_var_content = local_var_resp.text().await?;
89
90    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
91        serde_json::from_str(&local_var_content).map_err(Error::from)
92    } else {
93        let local_var_entity: Option<CreateSessionTokenFromTemplateError> = serde_json::from_str(&local_var_content).ok();
94        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
95        Err(Error::ResponseError(local_var_error))
96    }
97}
98
99/// Retrieve the details of a session
100pub async fn get_session(configuration: &configuration::Configuration, session_id: &str) -> Result<crate::models::Session, Error<GetSessionError>> {
101    let local_var_configuration = configuration;
102
103    let local_var_client = &local_var_configuration.client;
104
105    let local_var_uri_str = format!("{}/sessions/{session_id}", local_var_configuration.base_path, session_id=crate::apis::urlencode(session_id));
106    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
107
108    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
109        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
110    }
111    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
112        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
113    };
114
115    let local_var_req = local_var_req_builder.build()?;
116    let local_var_resp = local_var_client.execute(local_var_req).await?;
117
118    let local_var_status = local_var_resp.status();
119    let local_var_content = local_var_resp.text().await?;
120
121    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
122        serde_json::from_str(&local_var_content).map_err(Error::from)
123    } else {
124        let local_var_entity: Option<GetSessionError> = serde_json::from_str(&local_var_content).ok();
125        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
126        Err(Error::ResponseError(local_var_error))
127    }
128}
129
130/// Returns a list of all sessions. The sessions are returned sorted by creation date, with the newest sessions appearing first.
131pub async fn get_session_list(configuration: &configuration::Configuration, client_id: Option<&str>, user_id: Option<&str>, status: Option<&str>, limit: Option<f32>, offset: Option<f32>) -> Result<Vec<crate::models::Session>, Error<GetSessionListError>> {
132    let local_var_configuration = configuration;
133
134    let local_var_client = &local_var_configuration.client;
135
136    let local_var_uri_str = format!("{}/sessions", local_var_configuration.base_path);
137    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
138
139    if let Some(ref local_var_str) = client_id {
140        local_var_req_builder = local_var_req_builder.query(&[("client_id", &local_var_str.to_string())]);
141    }
142    if let Some(ref local_var_str) = user_id {
143        local_var_req_builder = local_var_req_builder.query(&[("user_id", &local_var_str.to_string())]);
144    }
145    if let Some(ref local_var_str) = status {
146        local_var_req_builder = local_var_req_builder.query(&[("status", &local_var_str.to_string())]);
147    }
148    if let Some(ref local_var_str) = limit {
149        local_var_req_builder = local_var_req_builder.query(&[("limit", &local_var_str.to_string())]);
150    }
151    if let Some(ref local_var_str) = offset {
152        local_var_req_builder = local_var_req_builder.query(&[("offset", &local_var_str.to_string())]);
153    }
154    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
155        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
156    }
157    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
158        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
159    };
160
161    let local_var_req = local_var_req_builder.build()?;
162    let local_var_resp = local_var_client.execute(local_var_req).await?;
163
164    let local_var_status = local_var_resp.status();
165    let local_var_content = local_var_resp.text().await?;
166
167    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
168        serde_json::from_str(&local_var_content).map_err(Error::from)
169    } else {
170        let local_var_entity: Option<GetSessionListError> = serde_json::from_str(&local_var_content).ok();
171        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
172        Err(Error::ResponseError(local_var_error))
173    }
174}
175
176/// Sets the status of a session as \"revoked\", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.
177pub async fn revoke_session(configuration: &configuration::Configuration, session_id: &str) -> Result<crate::models::Session, Error<RevokeSessionError>> {
178    let local_var_configuration = configuration;
179
180    let local_var_client = &local_var_configuration.client;
181
182    let local_var_uri_str = format!("{}/sessions/{session_id}/revoke", local_var_configuration.base_path, session_id=crate::apis::urlencode(session_id));
183    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
184
185    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
186        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
187    }
188    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
189        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
190    };
191
192    let local_var_req = local_var_req_builder.build()?;
193    let local_var_resp = local_var_client.execute(local_var_req).await?;
194
195    let local_var_status = local_var_resp.status();
196    let local_var_content = local_var_resp.text().await?;
197
198    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
199        serde_json::from_str(&local_var_content).map_err(Error::from)
200    } else {
201        let local_var_entity: Option<RevokeSessionError> = serde_json::from_str(&local_var_content).ok();
202        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
203        Err(Error::ResponseError(local_var_error))
204    }
205}
206
207/// Returns the session if it is authenticated, otherwise returns an error.
208pub async fn verify_session(configuration: &configuration::Configuration, session_id: &str, verify_session_request: Option<crate::models::VerifySessionRequest>) -> Result<crate::models::Session, Error<VerifySessionError>> {
209    let local_var_configuration = configuration;
210
211    let local_var_client = &local_var_configuration.client;
212
213    let local_var_uri_str = format!("{}/sessions/{session_id}/verify", local_var_configuration.base_path, session_id=crate::apis::urlencode(session_id));
214    let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
215
216    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
217        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
218    }
219    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
220        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
221    };
222    local_var_req_builder = local_var_req_builder.json(&verify_session_request);
223
224    let local_var_req = local_var_req_builder.build()?;
225    let local_var_resp = local_var_client.execute(local_var_req).await?;
226
227    let local_var_status = local_var_resp.status();
228    let local_var_content = local_var_resp.text().await?;
229
230    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
231        serde_json::from_str(&local_var_content).map_err(Error::from)
232    } else {
233        let local_var_entity: Option<VerifySessionError> = serde_json::from_str(&local_var_content).ok();
234        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
235        Err(Error::ResponseError(local_var_error))
236    }
237}
238
clerk_sdk_rust_community/apis/sessions_api.rs

clerk_sdk_rust_community/apis/
sessions_api.rs
