ServiceAccountKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
Attributes | |
|---|---|
| Name | Description |
name |
str
The resource name of the service account key in the following format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}.
|
private_key_type |
google.cloud.iam_admin_v1.types.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 |
google.cloud.iam_admin_v1.types.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 |
google.protobuf.timestamp_pb2.Timestamp
The key can be used after this timestamp. |
valid_before_time |
google.protobuf.timestamp_pb2.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 |
google.cloud.iam_admin_v1.types.ServiceAccountKeyOrigin
The key origin. |
key_type |
google.cloud.iam_admin_v1.types.ListServiceAccountKeysRequest.KeyType
The key type. |
disabled |
bool
The key status. |