ory_client/models/verify_api_key_response.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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct VerifyApiKeyResponse {
16 #[serde(rename = "actor_id", skip_serializing_if = "Option::is_none")]
17 pub actor_id: Option<String>,
18 #[serde(rename = "error_code", skip_serializing_if = "Option::is_none")]
19 pub error_code: Option<models::VerificationErrorCode>,
20 #[serde(rename = "error_message", skip_serializing_if = "Option::is_none")]
21 pub error_message: Option<String>,
22 #[serde(rename = "expire_time", skip_serializing_if = "Option::is_none")]
23 pub expire_time: Option<String>,
24 /// is_valid reports whether verification succeeded. It is true only when the credential parses, the signature checks out, the key was found, all policy gates (expiry, revocation, IP allowlist, rate limit) pass, and the key's status is KEY_STATUS_ACTIVE. When false, error_code and error_message describe the reason. Use this field for authentication decisions; use status to inspect lifecycle state independently.
25 #[serde(rename = "is_valid", skip_serializing_if = "Option::is_none")]
26 pub is_valid: Option<bool>,
27 /// The configured token issuer for this project. For derived tokens (JWT/macaroon), this matches the iss claim embedded in the verified token.
28 #[serde(rename = "issuer", skip_serializing_if = "Option::is_none")]
29 pub issuer: Option<String>,
30 #[serde(rename = "key_id", skip_serializing_if = "Option::is_none")]
31 pub key_id: Option<String>,
32 /// metadata mirrors the metadata stored on the verified key. AIP-148 metadata field.
33 #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
34 pub metadata: Option<serde_json::Value>,
35 #[serde(rename = "rate_limit_policy", skip_serializing_if = "Option::is_none")]
36 pub rate_limit_policy: Option<Box<models::RateLimitPolicy>>,
37 /// Approximate number of requests available before the rate limit is reached (commercial-only, only set when enforcement is active).
38 #[serde(rename = "rate_limit_remaining", skip_serializing_if = "Option::is_none")]
39 pub rate_limit_remaining: Option<String>,
40 /// Time when the rate limiter returns to full capacity (all quota recovered).
41 #[serde(rename = "rate_limit_reset_time", skip_serializing_if = "Option::is_none")]
42 pub rate_limit_reset_time: Option<String>,
43 #[serde(rename = "scopes", skip_serializing_if = "Option::is_none")]
44 pub scopes: Option<Vec<String>>,
45 #[serde(rename = "status", skip_serializing_if = "Option::is_none")]
46 pub status: Option<models::KeyStatus>,
47 #[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
48 pub visibility: Option<models::KeyVisibility>,
49}
50
51impl VerifyApiKeyResponse {
52 pub fn new() -> VerifyApiKeyResponse {
53 VerifyApiKeyResponse {
54 actor_id: None,
55 error_code: None,
56 error_message: None,
57 expire_time: None,
58 is_valid: None,
59 issuer: None,
60 key_id: None,
61 metadata: None,
62 rate_limit_policy: None,
63 rate_limit_remaining: None,
64 rate_limit_reset_time: None,
65 scopes: None,
66 status: None,
67 visibility: None,
68 }
69 }
70}
71