You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.</p>
@@ -130,9 +127,6 @@ <h3>Method Details</h3>
130
127
An object of the form:
131
128
132
129
{ # 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.
133
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
134
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
135
-
"description": "A String", # Optional. A user provided description of this service account key.
136
130
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
137
131
"disabled": True or False, # The key status.
138
132
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
@@ -241,9 +235,6 @@ <h3>Method Details</h3>
241
235
An object of the form:
242
236
243
237
{ # 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.
244
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
245
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
246
-
"description": "A String", # Optional. A user provided description of this service account key.
247
238
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
248
239
"disabled": True or False, # The key status.
249
240
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
@@ -286,9 +277,6 @@ <h3>Method Details</h3>
286
277
{ # The service account keys list response.
287
278
"keys": [ # The public keys for the service account.
288
279
{ # 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.
289
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
290
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
291
-
"description": "A String", # Optional. A user provided description of this service account key.
292
280
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
293
281
"disabled": True or False, # The key status.
294
282
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
name: string, The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. (required)
320
-
body: object, The request body.
321
-
The object takes the form of:
322
-
323
-
{ # The service account key patch request.
324
-
"serviceAccountKey": { # 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. # Required. The service account key to update.
325
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
326
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
327
-
"description": "A String", # Optional. A user provided description of this service account key.
328
-
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
329
-
"disabled": True or False, # The key status.
330
-
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
331
-
{ # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
332
-
"key": "A String", # The key for this extended status.
333
-
"value": "A String", # The value for the extended status.
334
-
},
335
-
],
336
-
"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
337
-
"keyOrigin": "A String", # The key origin.
338
-
"keyType": "A String", # The key type.
339
-
"name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
340
-
"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 gcloud auth activate-service-account.
341
-
"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.
342
-
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
343
-
"validAfterTime": "A String", # The key can be used after this timestamp.
344
-
"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.
345
-
},
346
-
"updateMask": "A String", # Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description
347
-
}
348
-
349
-
x__xgafv: string, V1 error format.
350
-
Allowed values
351
-
1 - v1 error format
352
-
2 - v2 error format
353
-
354
-
Returns:
355
-
An object of the form:
356
-
357
-
{ # 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.
358
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
359
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
360
-
"description": "A String", # Optional. A user provided description of this service account key.
361
-
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
362
-
"disabled": True or False, # The key status.
363
-
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
364
-
{ # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
365
-
"key": "A String", # The key for this extended status.
366
-
"value": "A String", # The value for the extended status.
367
-
},
368
-
],
369
-
"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
370
-
"keyOrigin": "A String", # The key origin.
371
-
"keyType": "A String", # The key type.
372
-
"name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
373
-
"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 gcloud auth activate-service-account.
374
-
"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.
375
-
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
376
-
"validAfterTime": "A String", # The key can be used after this timestamp.
377
-
"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>Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.
@@ -400,9 +321,6 @@ <h3>Method Details</h3>
400
321
An object of the form:
401
322
402
323
{ # 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.
403
-
"contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
404
-
"creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
405
-
"description": "A String", # Optional. A user provided description of this service account key.
406
324
"disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
407
325
"disabled": True or False, # The key status.
408
326
"extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
0 commit comments