Skip to main content

ory_client/models/
admin_rotate_issued_api_key_body.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.41
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// AdminRotateIssuedApiKeyBody : RotateIssuedAPIKeyRequest is the request for AdminRotateIssuedAPIKey.  Rotation is a custom method (AIP-136) that swaps an active key for a new one with a fresh secret and key_id, then revokes the old key. It is not a partial update, so it does not carry an update_mask. Mutable fields use presence-based semantics: an absent field inherits from the old key, while a present field (including an explicitly empty value) overrides.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct AdminRotateIssuedApiKeyBody {
17    #[serde(rename = "ip_restriction", skip_serializing_if = "Option::is_none")]
18    pub ip_restriction: Option<Box<models::IpRestriction>>,
19    /// metadata for the new API key. Absent (nil) inherits from the old key; present (including empty Struct) overrides.
20    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
21    pub metadata: Option<serde_json::Value>,
22    /// name for the new API key. Absent (HasName() == false) inherits from the old key; present (including empty string) overrides.
23    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
24    pub name: Option<String>,
25    #[serde(rename = "rate_limit_policy", skip_serializing_if = "Option::is_none")]
26    pub rate_limit_policy: Option<Box<models::RateLimitPolicy>>,
27    /// scopes for the new API key. Absent (nil slice) inherits from the old key; present (including empty list) overrides.
28    #[serde(rename = "scopes", skip_serializing_if = "Option::is_none")]
29    pub scopes: Option<Vec<String>>,
30    #[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
31    pub visibility: Option<models::KeyVisibility>,
32}
33
34impl AdminRotateIssuedApiKeyBody {
35    /// RotateIssuedAPIKeyRequest is the request for AdminRotateIssuedAPIKey.  Rotation is a custom method (AIP-136) that swaps an active key for a new one with a fresh secret and key_id, then revokes the old key. It is not a partial update, so it does not carry an update_mask. Mutable fields use presence-based semantics: an absent field inherits from the old key, while a present field (including an explicitly empty value) overrides.
36    pub fn new() -> AdminRotateIssuedApiKeyBody {
37        AdminRotateIssuedApiKeyBody {
38            ip_restriction: None,
39            metadata: None,
40            name: None,
41            rate_limit_policy: None,
42            scopes: None,
43            visibility: None,
44        }
45    }
46}
47