dsc/api/
api_keys.rs

1use super::client::DiscourseClient;
2use super::error::http_error;
3use anyhow::{Context, Result};
4use serde::{Deserialize, Serialize};
5use serde_json::Value;
6
7/// One row from /admin/api/keys.json.
8#[derive(Debug, Deserialize, Serialize, Clone)]
9pub struct ApiKeySummary {
10    pub id: u64,
11    #[serde(default)]
12    pub description: Option<String>,
13    #[serde(default, alias = "user_username")]
14    pub username: Option<String>,
15    #[serde(default)]
16    pub last_used_at: Option<String>,
17    #[serde(default)]
18    pub created_at: Option<String>,
19    #[serde(default)]
20    pub revoked_at: Option<String>,
21    #[serde(default)]
22    pub truncated_key: Option<String>,
23}
24
25/// Response from POST /admin/api/keys.json — includes the full secret `key`.
26#[derive(Debug, Deserialize, Serialize, Clone)]
27pub struct CreatedApiKey {
28    pub id: u64,
29    pub key: String,
30    #[serde(default)]
31    pub description: Option<String>,
32    #[serde(default, alias = "user_username")]
33    pub username: Option<String>,
34    #[serde(default)]
35    pub created_at: Option<String>,
36}
37
38impl DiscourseClient {
39    pub fn list_api_keys(&self) -> Result<Vec<ApiKeySummary>> {
40        let response = self.get("/admin/api/keys.json")?;
41        let status = response.status();
42        let text = response.text().context("reading api keys response")?;
43        if !status.is_success() {
44            return Err(http_error("api keys list request", status, &text));
45        }
46        let value: Value =
47            serde_json::from_str(&text).context("parsing api keys response json")?;
48        let keys_value = value
49            .get("keys")
50            .cloned()
51            .unwrap_or(Value::Array(Vec::new()));
52        let keys: Vec<ApiKeySummary> =
53            serde_json::from_value(keys_value).context("deserialising api keys")?;
54        Ok(keys)
55    }
56
57    /// Create a new API key. `username` of `None` makes a global all-users key.
58    pub fn create_api_key(&self, description: &str, username: Option<&str>) -> Result<CreatedApiKey> {
59        let mut payload: Vec<(&str, &str)> = vec![("key[description]", description)];
60        if let Some(u) = username {
61            payload.push(("key[username]", u));
62        }
63        let response = self
64            .send_retrying(|| Ok(self.post("/admin/api/keys.json")?.form(&payload)))?;
65        let status = response.status();
66        let text = response.text().context("reading api key create response")?;
67        if !status.is_success() {
68            return Err(http_error("api key create request", status, &text));
69        }
70        let value: Value =
71            serde_json::from_str(&text).context("parsing api key create response")?;
72        let key_obj = value.get("key").unwrap_or(&value);
73        let created: CreatedApiKey =
74            serde_json::from_value(key_obj.clone()).context("deserialising created api key")?;
75        Ok(created)
76    }
77
78    pub fn revoke_api_key(&self, key_id: u64) -> Result<()> {
79        let path = format!("/admin/api/keys/{}.json", key_id);
80        let response = self.send_retrying(|| Ok(self.delete_builder(&path)?))?;
81        let status = response.status();
82        if !status.is_success() {
83            let text = response
84                .text()
85                .unwrap_or_else(|_| "<failed to read response body>".to_string());
86            return Err(http_error("api key revoke request", status, &text));
87        }
88        Ok(())
89    }
90}
dsc/api/api_keys.rs

dsc/api/
api_keys.rs
