dakera_client/
keys.rs

1//! API Key management for the Dakera client.
2//!
3//! Provides methods for creating, listing, rotating, and managing API keys.
4
5use serde::{Deserialize, Serialize};
6
7use crate::error::Result;
8use crate::DakeraClient;
9
10// ============================================================================
11// Key Types
12// ============================================================================
13
14/// Request to create a new API key
15#[derive(Debug, Clone, Serialize, Deserialize)]
16pub struct CreateKeyRequest {
17    /// Human-readable name for this key
18    pub name: String,
19    /// Scope/permission level (read, write, admin, super_admin)
20    pub scope: String,
21    /// Optional: restrict to specific namespaces
22    #[serde(skip_serializing_if = "Option::is_none")]
23    pub namespaces: Option<Vec<String>>,
24    /// Optional: key expires in N days
25    #[serde(skip_serializing_if = "Option::is_none")]
26    pub expires_in_days: Option<u64>,
27}
28
29/// Response after creating an API key
30#[derive(Debug, Clone, Serialize, Deserialize)]
31pub struct CreateKeyResponse {
32    /// The API key ID (for management)
33    pub key_id: String,
34    /// The full API key (shown only once!)
35    pub key: String,
36    /// Key name
37    pub name: String,
38    /// Key scope
39    pub scope: String,
40    /// Namespaces this key can access
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub namespaces: Option<Vec<String>>,
43    /// When the key was created (Unix timestamp)
44    pub created_at: u64,
45    /// When the key expires (Unix timestamp), if set
46    #[serde(skip_serializing_if = "Option::is_none")]
47    pub expires_at: Option<u64>,
48    /// Warning message to save the key
49    pub warning: String,
50}
51
52/// API key info (without sensitive data)
53#[derive(Debug, Clone, Serialize, Deserialize)]
54pub struct KeyInfo {
55    pub key_id: String,
56    pub name: String,
57    pub scope: String,
58    #[serde(skip_serializing_if = "Option::is_none")]
59    pub namespaces: Option<Vec<String>>,
60    pub created_at: u64,
61    #[serde(skip_serializing_if = "Option::is_none")]
62    pub expires_at: Option<u64>,
63    pub active: bool,
64}
65
66/// List keys response
67#[derive(Debug, Clone, Serialize, Deserialize)]
68pub struct ListKeysResponse {
69    pub keys: Vec<KeyInfo>,
70    pub total: usize,
71}
72
73/// Generic success response
74#[derive(Debug, Clone, Serialize, Deserialize)]
75pub struct KeySuccessResponse {
76    pub success: bool,
77    pub message: String,
78}
79
80/// Rotate key response
81#[derive(Debug, Clone, Serialize, Deserialize)]
82pub struct RotateKeyResponse {
83    /// The new API key (shown only once!)
84    pub new_key: String,
85    /// The key ID (unchanged)
86    pub key_id: String,
87    /// Warning message
88    pub warning: String,
89}
90
91/// API key usage statistics
92#[derive(Debug, Clone, Serialize, Deserialize)]
93pub struct ApiKeyUsageResponse {
94    pub key_id: String,
95    pub total_requests: u64,
96    pub successful_requests: u64,
97    pub failed_requests: u64,
98    pub rate_limited_requests: u64,
99    pub bytes_transferred: u64,
100    pub avg_latency_ms: f64,
101    #[serde(default)]
102    pub by_endpoint: Vec<EndpointUsageInfo>,
103    #[serde(default)]
104    pub by_namespace: Vec<NamespaceUsageInfo>,
105}
106
107/// Usage statistics per endpoint
108#[derive(Debug, Clone, Serialize, Deserialize)]
109pub struct EndpointUsageInfo {
110    pub endpoint: String,
111    pub requests: u64,
112    pub avg_latency_ms: f64,
113}
114
115/// Usage statistics per namespace
116#[derive(Debug, Clone, Serialize, Deserialize)]
117pub struct NamespaceUsageInfo {
118    pub namespace: String,
119    pub requests: u64,
120    pub vectors_accessed: u64,
121}
122
123// ============================================================================
124// Key Client Methods
125// ============================================================================
126
127impl DakeraClient {
128    /// Create a new API key
129    pub async fn create_key(&self, request: CreateKeyRequest) -> Result<CreateKeyResponse> {
130        let url = format!("{}/admin/keys", self.base_url);
131        let response = self.client.post(&url).json(&request).send().await?;
132        self.handle_response(response).await
133    }
134
135    /// List all API keys
136    pub async fn list_keys(&self) -> Result<ListKeysResponse> {
137        let url = format!("{}/admin/keys", self.base_url);
138        let response = self.client.get(&url).send().await?;
139        self.handle_response(response).await
140    }
141
142    /// Get a specific API key by ID
143    pub async fn get_key(&self, key_id: &str) -> Result<KeyInfo> {
144        let url = format!("{}/admin/keys/{}", self.base_url, key_id);
145        let response = self.client.get(&url).send().await?;
146        self.handle_response(response).await
147    }
148
149    /// Delete (revoke) an API key
150    pub async fn delete_key(&self, key_id: &str) -> Result<KeySuccessResponse> {
151        let url = format!("{}/admin/keys/{}", self.base_url, key_id);
152        let response = self.client.delete(&url).send().await?;
153        self.handle_response(response).await
154    }
155
156    /// Deactivate an API key (soft delete)
157    pub async fn deactivate_key(&self, key_id: &str) -> Result<KeySuccessResponse> {
158        let url = format!("{}/admin/keys/{}/deactivate", self.base_url, key_id);
159        let response = self.client.post(&url).send().await?;
160        self.handle_response(response).await
161    }
162
163    /// Rotate an API key (creates new key, deactivates old)
164    pub async fn rotate_key(&self, key_id: &str) -> Result<RotateKeyResponse> {
165        let url = format!("{}/admin/keys/{}/rotate", self.base_url, key_id);
166        let response = self.client.post(&url).send().await?;
167        self.handle_response(response).await
168    }
169
170    /// Get API key usage statistics
171    pub async fn key_usage(&self, key_id: &str) -> Result<ApiKeyUsageResponse> {
172        let url = format!("{}/admin/keys/{}/usage", self.base_url, key_id);
173        let response = self.client.get(&url).send().await?;
174        self.handle_response(response).await
175    }
176}
dakera_client/keys.rs

dakera_client/
keys.rs
