Skip to main content

ory_client/models/
import_api_key_request.rs

1/*
2 * Ory APIs
3 *
4 * # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.  ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages:  | Language       | Download SDK                                                     | Documentation                                                                        | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart           | [pub.dev](https://pub.dev/packages/ory_client)                   | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md)       | | .NET           | [nuget.org](https://www.nuget.org/packages/Ory.Client/)          | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md)     | | Elixir         | [hex.pm](https://hex.pm/packages/ory_client)                     | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md)     | | Go             | [github.com](https://github.com/ory/client-go)                   | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md)         | | Java           | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md)       | | JavaScript     | [npmjs.com](https://www.npmjs.com/package/@ory/client)           | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch)           | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) |  | PHP            | [packagist.org](https://packagist.org/packages/ory/client)       | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md)        | | Python         | [pypi.org](https://pypi.org/project/ory-client/)                 | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md)     | | Ruby           | [rubygems.org](https://rubygems.org/gems/ory-client)             | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md)       | | Rust           | [crates.io](https://crates.io/crates/ory-client)                 | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md)       | 
5 *
6 * The version of the OpenAPI document: v1.22.40
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// ImportApiKeyRequest : Example:   {     \"raw_key\": \"sk_live_abc123xyz789\",     \"name\": \"Stripe Production Key\",     \"actor_id\": \"payment-processor\",     \"scopes\": [\"read\", \"write\"],     \"ttl\": \"8760h\",  // 1 year (also accepts: 31536000s)     \"metadata\": {\"source\": \"stripe\", \"environment\": \"production\"}   }
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct ImportApiKeyRequest {
17    /// actor_id is the identifier of the entity that owns this imported key. Required so every imported key is traceable to an actor for revocation and audit queries.
18    #[serde(rename = "actor_id", skip_serializing_if = "Option::is_none")]
19    pub actor_id: Option<String>,
20    #[serde(rename = "ip_restriction", skip_serializing_if = "Option::is_none")]
21    pub ip_restriction: Option<Box<models::IpRestriction>>,
22    /// metadata is a free-form JSON object for caller-defined attributes (e.g., source, environment, tags). Values may be strings, numbers, booleans, arrays, objects, or null. Total serialized size is capped at 4KB. AIP-148 metadata field.
23    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
24    pub metadata: Option<serde_json::Value>,
25    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
26    pub name: Option<String>,
27    #[serde(rename = "rate_limit_policy", skip_serializing_if = "Option::is_none")]
28    pub rate_limit_policy: Option<Box<models::RateLimitPolicy>>,
29    #[serde(rename = "raw_key", skip_serializing_if = "Option::is_none")]
30    pub raw_key: Option<String>,
31    #[serde(rename = "request_id", skip_serializing_if = "Option::is_none")]
32    pub request_id: Option<String>,
33    #[serde(rename = "scopes", skip_serializing_if = "Option::is_none")]
34    pub scopes: Option<Vec<String>>,
35    /// ttl sets the expiry as a duration from now. Encoded as a google.protobuf.Duration (string ending in \"s\", e.g. \"3600s\"). Accepted bounds: 1s to 315360000s (~10 years). If unset or zero, the project default TTL applies. For convenience, the server also accepts Go-style duration strings (\"24h\", \"30m\", \"1h30m\") and an extended unit set (\"1d\", \"1w\", \"1mo\", \"1y\"; approximations: 1mo = 30d, 1y = 365d). Clients should prefer the standard Duration encoding for portability.
36    #[serde(rename = "ttl", skip_serializing_if = "Option::is_none")]
37    pub ttl: Option<String>,
38    #[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
39    pub visibility: Option<models::KeyVisibility>,
40}
41
42impl ImportApiKeyRequest {
43    /// Example:   {     \"raw_key\": \"sk_live_abc123xyz789\",     \"name\": \"Stripe Production Key\",     \"actor_id\": \"payment-processor\",     \"scopes\": [\"read\", \"write\"],     \"ttl\": \"8760h\",  // 1 year (also accepts: 31536000s)     \"metadata\": {\"source\": \"stripe\", \"environment\": \"production\"}   }
44    pub fn new() -> ImportApiKeyRequest {
45        ImportApiKeyRequest {
46            actor_id: None,
47            ip_restriction: None,
48            metadata: None,
49            name: None,
50            rate_limit_policy: None,
51            raw_key: None,
52            request_id: None,
53            scopes: None,
54            ttl: None,
55            visibility: None,
56        }
57    }
58}
59