Struct ServiceAccountKey 

#[non_exhaustive]
pub struct ServiceAccountKey {
    pub name: String,
    pub private_key_type: ServiceAccountPrivateKeyType,
    pub key_algorithm: ServiceAccountKeyAlgorithm,
    pub private_key_data: Bytes,
    pub public_key_data: Bytes,
    pub valid_after_time: Option<Timestamp>,
    pub valid_before_time: Option<Timestamp>,
    pub key_origin: ServiceAccountKeyOrigin,
    pub key_type: KeyType,
    pub disabled: bool,
    /* private fields */
}

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key.

System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key’s lifetime.

If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The resource name of the service account key in the following format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}.

private_key_type: ServiceAccountPrivateKeyType

The output format for the private key. Only provided in CreateServiceAccountKey responses, not in GetServiceAccountKey or ListServiceAccountKey responses.

Google never exposes system-managed private keys, and never retains user-managed private keys.

key_algorithm: ServiceAccountKeyAlgorithm

Specifies the algorithm (and possibly key size) for the key.

private_key_data: Bytes

The private key data. Only provided in CreateServiceAccountKey responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.

public_key_data: Bytes

The public key data. Only provided in GetServiceAccountKey responses.

valid_after_time: Option<Timestamp>

The key can be used after this timestamp.

valid_before_time: Option<Timestamp>

The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.

key_origin: ServiceAccountKeyOrigin

The key origin.

key_type: KeyType

The key type.

disabled: bool

The key status.

Implementations

impl ServiceAccountKey

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_private_key_type<T: Into<ServiceAccountPrivateKeyType>>( self, v: T, ) -> Self

Sets the value of private_key_type.

pub fn set_key_algorithm<T: Into<ServiceAccountKeyAlgorithm>>( self, v: T, ) -> Self

Sets the value of key_algorithm.

pub fn set_private_key_data<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of private_key_data.

pub fn set_public_key_data<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of public_key_data.

pub fn set_valid_after_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of valid_after_time.

pub fn set_or_clear_valid_after_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of valid_after_time.

pub fn set_valid_before_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of valid_before_time.

pub fn set_or_clear_valid_before_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of valid_before_time.

pub fn set_key_origin<T: Into<ServiceAccountKeyOrigin>>(self, v: T) -> Self

Sets the value of key_origin.

pub fn set_key_type<T: Into<KeyType>>(self, v: T) -> Self

Sets the value of key_type.

pub fn set_disabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of disabled.

Trait Implementations

impl Clone for ServiceAccountKey

fn clone(&self) -> ServiceAccountKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceAccountKey

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

Formats the value using the given formatter.

impl Default for ServiceAccountKey

fn default() -> ServiceAccountKey

Returns the “default value” for a type.

impl Message for ServiceAccountKey

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ServiceAccountKey

fn eq(&self, other: &ServiceAccountKey) -> 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 StructuralPartialEq for ServiceAccountKey