Struct ApiKey 

pub struct ApiKey {

    pub key_id: String,
    pub label: String,
    pub icon: String,
    pub color: String,
    pub ip_whitelist: Vec<String>,
    pub status: EnumValue<ApiKeyStatus>,
    pub subaccount_id: Option<u64>,
    pub policy_id: Option<u64>,
    pub created_at: MessageField<Timestamp>,
    pub last_used_at: MessageField<Timestamp>,
    pub public_key_ed25519: Vec<u8>,
    pub expires_at: MessageField<Timestamp>,
    pub created_by_actor: String,
    pub updated_at: MessageField<Timestamp>,
    pub revision: u64,
    /* private fields */
}

ApiKey is public API key metadata. It never includes the private key or seed.

Fields

key_id: String

Stable opaque identifier used to refer to this key, formatted as “ak_” followed by 32 lowercase hex characters.

Field 2: key_id

label: String

Human-readable label for the key. Maximum length is 64 characters.

Field 3: label

icon: String

Optional user-chosen icon/emoji for UI display.

Field 9: icon

color: String

Optional user-chosen color token for UI display.

Field 10: color

ip_whitelist: Vec<String>

Optional CIDR whitelist. Empty means no IP restriction. Maximum 32 unique entries.

Field 4: ip_whitelist

status: EnumValue<ApiKeyStatus>

Current key status.

Field 6: status

subaccount_id: Option<u64>

Optional sub-account this key is scoped to (opaque ID; empty = root-level).

Field 7: subaccount_id

policy_id: Option<u64>

Optional API policy attached to this key (opaque ID). Empty means “no per-key policy”, so only the sub-account policy (and roles) apply.

Field 8: policy_id

created_at: MessageField<Timestamp>

Time in UTC when this key was created.

Field 20: created_at

last_used_at: MessageField<Timestamp>

Last time in UTC when this key authenticated a request. Omitted when the key has not been used.

Field 21: last_used_at

public_key_ed25519: Vec<u8>

Ed25519 public key bytes associated with this API key. The private key or seed is never returned by the API.

Field 22: public_key_ed25519

expires_at: MessageField<Timestamp>

Optional expiry time in UTC. When set, the key cannot authenticate requests after this time, regardless of status.

Field 23: expires_at

created_by_actor: String

Read-only actor label describing who created this key, such as a username or account label.

Field 24: created_by_actor

updated_at: MessageField<Timestamp>

Time in UTC when this key’s configuration was last changed. For the same key, later is fresher, equal is an idempotent replay, and earlier is stale. Equal timestamps with different configuration indicate an invariant failure. This is independent of last_used_at, which tracks authentication activity.

Field 25: updated_at

revision: u64

Monotonic resource revision used for conditional updates.

Field 26: revision

Implementations

impl ApiKey

pub const TYPE_URL: &'static str = "type.googleapis.com/auth.v1.ApiKey"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

impl ApiKey

pub fn with_subaccount_id(self, value: u64) -> Self

Sets Self::subaccount_id to Some(value), consuming and returning self.

pub fn with_policy_id(self, value: u64) -> Self

Sets Self::policy_id to Some(value), consuming and returning self.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl Default for ApiKey

fn default() -> ApiKey

Returns the “default value” for a type.

impl DefaultInstance for ApiKey

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for ApiKey

where ApiKey: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtensionSet for ApiKey

const PROTO_FQN: &'static str = "auth.v1.ApiKey"

Fully-qualified proto type name of this message (no leading dot), e.g. "google.protobuf.FieldOptions".

fn unknown_fields(&self) -> &UnknownFields

Immutable access to the extendee’s unknown-field storage.

fn unknown_fields_mut(&mut self) -> &mut UnknownFields

Mutable access to the extendee’s unknown-field storage.

fn extension<C>(&self, ext: &Extension<C>) -> <C as ExtensionCodec>::Output

where C: ExtensionCodec,

Read an extension value.

fn set_extension<C>( &mut self, ext: &Extension<C>, value: <C as ExtensionCodec>::Value, )

where C: ExtensionCodec,

Write an extension value, replacing any prior occurrences.

fn has_extension<C>(&self, ext: &Extension<C>) -> bool

where C: ExtensionCodec,

Returns true if any record at the extension’s field number is present.

fn clear_extension<C>(&mut self, ext: &Extension<C>)

where C: ExtensionCodec,

Remove all records at the extension’s field number.

fn extension_or_default<C>( &self, ext: &Extension<C>, ) -> <C as ExtensionCodec>::Value

where C: ExtensionCodec<Output = Option<<C as ExtensionCodec>::Value>>, <C as ExtensionCodec>::Value: Default,

Read a singular extension value, returning the proto2 [default = ...] value if absent, or the type’s Default if no proto default was declared.

impl HasMessageView for ApiKey

type View<'a> = ApiKeyView<'a>

The zero-copy view of Self, borrowing from a buffer with lifetime 'a.

type ViewHandle = ApiKeyOwnedView

The generated 'static owned-view handle for Self (FooOwnedView).

fn decode_view(buf: &[u8]) -> Result<Self::View<'_>, DecodeError>

Decode a borrowed View from a byte slice.

fn decode_view_with_options<'a>( buf: &'a [u8], opts: &DecodeOptions, ) -> Result<Self::View<'a>, DecodeError>

Decode a borrowed View under custom DecodeOptions (recursion limit, max message size, unknown-field limit).

fn decode_view_handle(bytes: Bytes) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle from a Bytes buffer.

fn decode_view_handle_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle with custom DecodeOptions (recursion limit, max message size).

impl Message for ApiKey

fn compute_size(&self, __cache: &mut SizeCache) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache).

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. This is the primary encoding API.

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

fn encode_to_vec(&self) -> Vec<u8>

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

fn decode_length_delimited(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

fn merge( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

fn merge_length_delimited( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a length-delimited sub-message payload into this message.

impl MessageName for ApiKey

const PACKAGE: &'static str = "auth.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "ApiKey"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "auth.v1.ApiKey"

The fully-qualified protobuf type name with no leading dot.

const TYPE_URL: &'static str = "type.googleapis.com/auth.v1.ApiKey"

The google.protobuf.Any.type_url form for this message.

impl PartialEq for ApiKey

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

Equality operator ==.

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

Inequality operator !=.

impl ProtoElemJson for ApiKey

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

impl Serialize for ApiKey

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 ApiKey