Struct VerifyApiKeyResponse 

pub struct VerifyApiKeyResponse {

    pub actor_id: Option<String>,
    pub error_code: Option<VerificationErrorCode>,
    pub error_message: Option<String>,
    pub expire_time: Option<String>,
    pub is_valid: Option<bool>,
    pub issuer: Option<String>,
    pub key_id: Option<String>,
    pub metadata: Option<Value>,
    pub rate_limit_policy: Option<Box<RateLimitPolicy>>,
    pub rate_limit_remaining: Option<String>,
    pub rate_limit_reset_time: Option<String>,
    pub scopes: Option<Vec<String>>,
    pub status: Option<KeyStatus>,
    pub visibility: Option<KeyVisibility>,
}

Fields

actor_id: Option<String>

error_code: Option<VerificationErrorCode>

error_message: Option<String>

expire_time: Option<String>

is_valid: Option<bool>

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.

issuer: Option<String>

The configured token issuer for this project. For derived tokens (JWT/macaroon), this matches the iss claim embedded in the verified token.

key_id: Option<String>

metadata: Option<Value>

metadata mirrors the metadata stored on the verified key. AIP-148 metadata field.

rate_limit_policy: Option<Box<RateLimitPolicy>>

rate_limit_remaining: Option<String>

Approximate number of requests available before the rate limit is reached (commercial-only, only set when enforcement is active).

rate_limit_reset_time: Option<String>

Time when the rate limiter returns to full capacity (all quota recovered).

scopes: Option<Vec<String>>

status: Option<KeyStatus>

visibility: Option<KeyVisibility>

Implementations

impl VerifyApiKeyResponse

pub fn new() -> VerifyApiKeyResponse

Trait Implementations

impl Clone for VerifyApiKeyResponse

fn clone(&self) -> VerifyApiKeyResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VerifyApiKeyResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VerifyApiKeyResponse

fn default() -> VerifyApiKeyResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VerifyApiKeyResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VerifyApiKeyResponse

fn eq(&self, other: &VerifyApiKeyResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VerifyApiKeyResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VerifyApiKeyResponse