docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
index 6fc63ba..149c479 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
@@ -105,12 +105,12 @@
The object takes the form of:
{ # The service account key create request.
- "privateKeyType": "A String", # The output format of the private key. The default value is
- # `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File
- # format.
- "keyAlgorithm": "A String", # Which type of key and algorithm to use for the key.
+ "keyAlgorithm": "A String", # Which type of key and algorithm to use for the key.
# The default is currently a 2K RSA key. However this may change in the
# future.
+ "privateKeyType": "A String", # The output format of the private key. The default value is
+ # `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File
+ # format.
}
x__xgafv: string, V1 error format.
@@ -133,36 +133,36 @@
#
# 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
+ # and usage of the new key will gradually ramp up and down over the key's
# lifetime. We recommend caching the public key set for a service account for
# no more than 24 hours to ensure you have access to the latest keys.
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "keyOrigin": "A String", # The key origin.
- "validAfterTime": "A String", # The key can be used after this timestamp.
- "keyType": "A String", # The key type.
- "validBeforeTime": "A String", # 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.
- "privateKeyData": "A String", # 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
- # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
- # auth activate-service-account</a>.
- "privateKeyType": "A String", # The output format for the private key.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # 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.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
- "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "name": "A String", # The resource name of the service account key in the following format
+ "validAfterTime": "A String", # The key can be used after this timestamp.
+ "keyOrigin": "A String", # The key origin.
+ "privateKeyData": "A String", # 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
+ # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
+ # auth activate-service-account</a>.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "keyType": "A String", # The key type.
+ "name": "A String", # The resource name of the service account key in the following format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+ "validBeforeTime": "A String", # 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.
}</pre>
</div>
@@ -230,36 +230,36 @@
#
# 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
+ # and usage of the new key will gradually ramp up and down over the key's
# lifetime. We recommend caching the public key set for a service account for
# no more than 24 hours to ensure you have access to the latest keys.
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "keyOrigin": "A String", # The key origin.
- "validAfterTime": "A String", # The key can be used after this timestamp.
- "keyType": "A String", # The key type.
- "validBeforeTime": "A String", # 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.
- "privateKeyData": "A String", # 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
- # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
- # auth activate-service-account</a>.
- "privateKeyType": "A String", # The output format for the private key.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # 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.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
- "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "name": "A String", # The resource name of the service account key in the following format
+ "validAfterTime": "A String", # The key can be used after this timestamp.
+ "keyOrigin": "A String", # The key origin.
+ "privateKeyData": "A String", # 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
+ # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
+ # auth activate-service-account</a>.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "keyType": "A String", # The key type.
+ "name": "A String", # The resource name of the service account key in the following format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+ "validBeforeTime": "A String", # 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.
}</pre>
</div>
@@ -286,7 +286,7 @@
An object of the form:
{ # The service account keys list response.
- "keys": [ # The public keys for the service account.
+ "keys": [ # The public keys for the service account.
{ # Represents a service account key.
#
# A service account has two sets of key-pairs: user-managed, and
@@ -299,36 +299,36 @@
#
# 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
+ # and usage of the new key will gradually ramp up and down over the key's
# lifetime. We recommend caching the public key set for a service account for
# no more than 24 hours to ensure you have access to the latest keys.
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "keyOrigin": "A String", # The key origin.
- "validAfterTime": "A String", # The key can be used after this timestamp.
- "keyType": "A String", # The key type.
- "validBeforeTime": "A String", # 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.
- "privateKeyData": "A String", # 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
- # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
- # auth activate-service-account</a>.
- "privateKeyType": "A String", # The output format for the private key.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # 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.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
- "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "name": "A String", # The resource name of the service account key in the following format
+ "validAfterTime": "A String", # The key can be used after this timestamp.
+ "keyOrigin": "A String", # The key origin.
+ "privateKeyData": "A String", # 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
+ # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
+ # auth activate-service-account</a>.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "keyType": "A String", # The key type.
+ "name": "A String", # The resource name of the service account key in the following format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+ "validBeforeTime": "A String", # 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.
},
],
}</pre>
@@ -351,7 +351,7 @@
The object takes the form of:
{ # The service account key upload request.
- "publicKeyData": "A String", # A field that allows clients to upload their own public key. If set,
+ "publicKeyData": "A String", # A field that allows clients to upload their own public key. If set,
# use this public key data to create a service account key for given
# service account.
# Please note, the expected format for this field is X509_PEM.
@@ -377,36 +377,36 @@
#
# 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
+ # and usage of the new key will gradually ramp up and down over the key's
# lifetime. We recommend caching the public key set for a service account for
# no more than 24 hours to ensure you have access to the latest keys.
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "keyOrigin": "A String", # The key origin.
- "validAfterTime": "A String", # The key can be used after this timestamp.
- "keyType": "A String", # The key type.
- "validBeforeTime": "A String", # 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.
- "privateKeyData": "A String", # 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
- # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
- # auth activate-service-account</a>.
- "privateKeyType": "A String", # The output format for the private key.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+ "privateKeyType": "A String", # 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.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
- "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "name": "A String", # The resource name of the service account key in the following format
+ "validAfterTime": "A String", # The key can be used after this timestamp.
+ "keyOrigin": "A String", # The key origin.
+ "privateKeyData": "A String", # 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
+ # <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud
+ # auth activate-service-account</a>.
+ "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+ "keyType": "A String", # The key type.
+ "name": "A String", # The resource name of the service account key in the following format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+ "validBeforeTime": "A String", # 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.
}</pre>
</div>