Struct google_api_proto::google::iam::admin::v1::ServiceAccountKey

pub struct ServiceAccountKey {
    pub name: String,
    pub private_key_type: i32,
    pub key_algorithm: i32,
    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: i32,
    pub key_type: i32,
    pub disabled: bool,
}

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

name: String

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

private_key_type: i32

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: i32

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: i32

The key origin.

key_type: i32

The key type.

disabled: bool

The key status.

Implementations

impl ServiceAccountKey

pub fn private_key_type(&self) -> ServiceAccountPrivateKeyType

Returns the enum value of private_key_type, or the default if the field is set to an invalid enum value.

pub fn set_private_key_type(&mut self, value: ServiceAccountPrivateKeyType)

Sets private_key_type to the provided enum value.

pub fn key_algorithm(&self) -> ServiceAccountKeyAlgorithm

Returns the enum value of key_algorithm, or the default if the field is set to an invalid enum value.

pub fn set_key_algorithm(&mut self, value: ServiceAccountKeyAlgorithm)

Sets key_algorithm to the provided enum value.

pub fn key_origin(&self) -> ServiceAccountKeyOrigin

Returns the enum value of key_origin, or the default if the field is set to an invalid enum value.

pub fn set_key_origin(&mut self, value: ServiceAccountKeyOrigin)

Sets key_origin to the provided enum value.

pub fn key_type(&self) -> KeyType

Returns the enum value of key_type, or the default if the field is set to an invalid enum value.

pub fn set_key_type(&mut self, value: KeyType)

Sets key_type to the provided enum value.

Trait Implementations

impl Clone for ServiceAccountKey

fn clone(&self) -> ServiceAccountKey

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for ServiceAccountKey

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

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

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

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

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ServiceAccountKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ServiceAccountKey