Skip to main content

langfuse_client_base/models/
organization_api_key.rs

1/*
2 * server
3 *
4 * ## Real-time data  The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion).  ## Authentication  Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings:  - username: Langfuse Public Key - password: Langfuse Secret Key  ## Exports  - OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
15pub struct OrganizationApiKey {
16    #[serde(rename = "id")]
17    pub id: String,
18    #[serde(rename = "createdAt")]
19    pub created_at: chrono::DateTime<chrono::FixedOffset>,
20    /// Expiration timestamp. Null if the key does not expire.
21    #[serde(
22        rename = "expiresAt",
23        default,
24        with = "::serde_with::rust::double_option",
25        skip_serializing_if = "Option::is_none"
26    )]
27    pub expires_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
28    #[serde(
29        rename = "lastUsedAt",
30        default,
31        with = "::serde_with::rust::double_option",
32        skip_serializing_if = "Option::is_none"
33    )]
34    pub last_used_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
35    /// Name of the API key. Contains the same value as note; null if no name was provided.
36    #[serde(
37        rename = "name",
38        default,
39        with = "::serde_with::rust::double_option",
40        skip_serializing_if = "Option::is_none"
41    )]
42    pub name: Option<Option<String>>,
43    /// Deprecated alias for name. Contains the same value as name.
44    #[serde(
45        rename = "note",
46        default,
47        with = "::serde_with::rust::double_option",
48        skip_serializing_if = "Option::is_none"
49    )]
50    pub note: Option<Option<String>>,
51    #[serde(rename = "publicKey")]
52    pub public_key: String,
53    #[serde(rename = "displaySecretKey")]
54    pub display_secret_key: String,
55}
56
57impl OrganizationApiKey {
58    pub fn new(
59        id: String,
60        created_at: chrono::DateTime<chrono::FixedOffset>,
61        public_key: String,
62        display_secret_key: String,
63    ) -> OrganizationApiKey {
64        OrganizationApiKey {
65            id,
66            created_at,
67            expires_at: None,
68            last_used_at: None,
69            name: None,
70            note: None,
71            public_key,
72            display_secret_key,
73        }
74    }
75}