scm-sdk 0.2.2

Native async Strata Cloud Manager SDK, beginning with Prisma AIRS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Token administration endpoints, distinct from the shared service-token cache.
use super::models::{ClientIdAndCustomerApp, Oauth2Token};
use crate::{
    Client, RawRequest, RequestOptions, Result, Secret, data::FiniteNumber, engine::AuthKind,
};
use http::Method;
use std::fmt;

/// Optional token TTL query values. The service owns units and permitted ranges.
#[derive(Clone)]
#[non_exhaustive]
pub struct GetTokenOptions {
    pub body: ClientIdAndCustomerApp,
    pub token_ttl_interval: Option<FiniteNumber>,
    pub token_ttl_unit: Option<String>,
}
impl GetTokenOptions {
    pub fn new(body: ClientIdAndCustomerApp) -> Self {
        Self {
            body,
            token_ttl_interval: None,
            token_ttl_unit: None,
        }
    }
    pub fn with_token_ttl_interval(mut self, value: FiniteNumber) -> Self {
        self.token_ttl_interval = Some(value);
        self
    }
    pub fn with_token_ttl_unit(mut self, value: impl Into<String>) -> Self {
        self.token_ttl_unit = Some(value.into());
        self
    }
}
impl fmt::Debug for GetTokenOptions {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("GetTokenOptions([REDACTED])")
    }
}

#[derive(Clone, Debug)]
pub struct OAuthManagementClient {
    client: Client,
}
impl OAuthManagementClient {
    pub fn new(client: Client) -> Result<Self> {
        client.require_auth(AuthKind::OAuth)?;
        // Frozen management operations use bearer authentication without tenant routing.
        Ok(Self {
            client: client.with_tsg_header(false)?,
        })
    }
    pub fn client(&self) -> &Client {
        &self.client
    }
    /// Create an application token; its payload remains explicit and Debug-redacted.
    /// This POST is never replayed after an uncertain outcome.
    pub async fn get_access_token(
        &self,
        input: &GetTokenOptions,
        options: Option<&RequestOptions>,
    ) -> Result<Oauth2Token> {
        let mut query = Vec::new();
        if let Some(interval) = &input.token_ttl_interval {
            let number = interval
                .as_f64()
                .ok_or_else(|| crate::Error::new(crate::ErrorKind::Validation))?;
            let mut buffer = ryu_js::Buffer::new();
            query.push(("tokenTtlInterval".into(), buffer.format(number).into()));
        }
        if let Some(unit) = &input.token_ttl_unit {
            query.push(("tokenTtlUnit".into(), unit.clone()));
        }
        self.client
            .send_model(
                RawRequest::new(Method::POST, "/v1/mgmt/oauth/client_credential/accesstoken")
                    .named("airs.management.oauth.get_access_token")
                    .query(query),
                &input.body,
                "ClientIdAndCustomerAppSchema",
                "Oauth2TokenSchema",
                options,
            )
            .await
    }
    /// Invalidate an application token. The token is query data, never a path or log.
    /// Return the endpoint's JSON string confirmation without treating it as plain text.
    pub async fn invalidate_token(
        &self,
        token: &Secret,
        body: &ClientIdAndCustomerApp,
        options: Option<&RequestOptions>,
    ) -> Result<String> {
        let options = self.client.operation_options(options)?;
        let bytes = self
            .client
            .validated_json(body, "ClientIdAndCustomerAppSchema", &options)
            .await?;
        self.client
            .send_json(
                RawRequest::new(Method::POST, "/v1/mgmt/oauth/invalidateToken")
                    .named("airs.management.oauth.invalidate_token")
                    .query([("token".into(), token.expose().into())])
                    .body(bytes, "application/json")?,
                Some(&options),
            )
            .await
    }
}