Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8ed1dcdf85556905681146bf5fcadf6540a508e9 / . / docs / dyn / cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
blob: f7fb34daf00a8643f61efe6d23956cf4b87a319a [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a> . <a href="cloudkms_v1.projects.locations.keyRings.html">keyRings</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html">cryptoKeyVersions()</a></code>
</p>
<p class="firstline">Returns the cryptoKeyVersions Resource.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, skipInitialVersionCreation=None, cryptoKeyId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new CryptoKey within a KeyRing.</p>
<p class="toc_element">
<code><a href="#decrypt">decrypt(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Decrypts data that was protected by Encrypt. The CryptoKey.purpose</p>
<p class="toc_element">
<code><a href="#encrypt">encrypt(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Encrypts data, so that it can only be recovered by a call to Decrypt.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns metadata for a given CryptoKey, as well as its</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource.</p>
<p class="toc_element">
<code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, versionView=None, filter=None)</a></code></p>
<p class="firstline">Lists CryptoKeys.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a CryptoKey.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<p class="toc_element">
<code><a href="#updatePrimaryVersion">updatePrimaryVersion(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the version of a CryptoKey that will be used in Encrypt.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, skipInitialVersionCreation=None, cryptoKeyId=None, x__xgafv=None)</code>
<pre>Create a new CryptoKey within a KeyRing.
CryptoKey.purpose and
CryptoKey.version_template.algorithm
are required.
Args:
parent: string, Required. The name of the KeyRing associated with the
CryptoKeys. (required)
body: object, The request body.
The object takes the form of:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}
skipInitialVersionCreation: boolean, If set to true, the request will create a CryptoKey without any
CryptoKeyVersions. You must manually call
CreateCryptoKeyVersion or
ImportCryptoKeyVersion
before you can use this CryptoKey.
cryptoKeyId: string, Required. It must be unique within a KeyRing and match the regular
expression `[a-zA-Z0-9_-]{1,63}`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}</pre>
</div>
<div class="method">
<code class="details" id="decrypt">decrypt(name, body=None, x__xgafv=None)</code>
<pre>Decrypts data that was protected by Encrypt. The CryptoKey.purpose
must be ENCRYPT_DECRYPT.
Args:
name: string, Required. The resource name of the CryptoKey to use for decryption.
The server will choose the appropriate version. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for KeyManagementService.Decrypt.
"ciphertext": "A String", # Required. The encrypted data originally returned in
# EncryptResponse.ciphertext.
"additionalAuthenticatedData": "A String", # Optional. Optional data that must match the data originally supplied in
# EncryptRequest.additional_authenticated_data.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for KeyManagementService.Decrypt.
"plaintext": "A String", # The decrypted data originally supplied in EncryptRequest.plaintext.
}</pre>
</div>
<div class="method">
<code class="details" id="encrypt">encrypt(name, body=None, x__xgafv=None)</code>
<pre>Encrypts data, so that it can only be recovered by a call to Decrypt.
The CryptoKey.purpose must be
ENCRYPT_DECRYPT.
Args:
name: string, Required. The resource name of the CryptoKey or CryptoKeyVersion
to use for encryption.
If a CryptoKey is specified, the server will use its
primary version. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for KeyManagementService.Encrypt.
"plaintext": "A String", # Required. The data to encrypt. Must be no larger than 64KiB.
#
# The maximum size depends on the key version's
# protection_level. For
# SOFTWARE keys, the plaintext must be no larger
# than 64KiB. For HSM keys, the combined length of the
# plaintext and additional_authenticated_data fields must be no larger than
# 8KiB.
"additionalAuthenticatedData": "A String", # Optional. Optional data that, if specified, must also be provided during decryption
# through DecryptRequest.additional_authenticated_data.
#
# The maximum size depends on the key version's
# protection_level. For
# SOFTWARE keys, the AAD must be no larger than
# 64KiB. For HSM keys, the combined length of the
# plaintext and additional_authenticated_data fields must be no larger than
# 8KiB.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for KeyManagementService.Encrypt.
"ciphertext": "A String", # The encrypted data.
"name": "A String", # The resource name of the CryptoKeyVersion used in encryption. Check
# this field to verify that the intended resource was used for encryption.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns metadata for a given CryptoKey, as well as its
primary CryptoKeyVersion.
Args:
name: string, Required. The name of the CryptoKey to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested.
See the operation documentation for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Requests for policies with any conditional bindings must specify version 3.
Policies without any conditional bindings may specify any valid value or
leave the field unset.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
# Optionally, a `binding` can specify a `condition`, which is a logical
# expression that allows access to a resource only if the expression evaluates
# to `true`. A condition can add constraints based on attributes of the
# request, the resource, or both.
#
# **JSON example:**
#
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": ["user:eve@example.com"],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
#
# **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() &lt; 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, versionView=None, filter=None)</code>
<pre>Lists CryptoKeys.
Args:
parent: string, Required. The resource name of the KeyRing to list, in the format
`projects/*/locations/*/keyRings/*`. (required)
orderBy: string, Optional. Specify how the results should be sorted. If not specified, the
results will be sorted in the default order. For more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).
pageSize: integer, Optional. Optional limit on the number of CryptoKeys to include in the
response. Further CryptoKeys can subsequently be obtained by
including the ListCryptoKeysResponse.next_page_token in a subsequent
request. If unspecified, the server will pick an appropriate default.
pageToken: string, Optional. Optional pagination token, returned earlier via
ListCryptoKeysResponse.next_page_token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
versionView: string, The fields of the primary version to include in the response.
filter: string, Optional. Only include resources that match the filter in the response. For
more information, see
[Sorting and filtering list
results](https://cloud.google.com/kms/docs/sorting-and-filtering).
Returns:
An object of the form:
{ # Response message for KeyManagementService.ListCryptoKeys.
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in
# ListCryptoKeysRequest.page_token to retrieve the next page of results.
"cryptoKeys": [ # The list of CryptoKeys.
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
},
],
"totalSize": 42, # The total number of CryptoKeys that matched the query.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update a CryptoKey.
Args:
name: string, Output only. The resource name for this CryptoKey in the format
`projects/*/locations/*/keyRings/*/cryptoKeys/*`. (required)
body: object, The request body.
The object takes the form of:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}
updateMask: string, Required. List of fields to be updated in this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any
existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
# Optionally, a `binding` can specify a `condition`, which is a logical
# expression that allows access to a resource only if the expression evaluates
# to `true`. A condition can add constraints based on attributes of the
# request, the resource, or both.
#
# **JSON example:**
#
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": ["user:eve@example.com"],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
#
# **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() &lt; 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
# Optionally, a `binding` can specify a `condition`, which is a logical
# expression that allows access to a resource only if the expression evaluates
# to `true`. A condition can add constraints based on attributes of the
# request, the resource, or both.
#
# **JSON example:**
#
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": ["user:eve@example.com"],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
#
# **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() &lt; 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="updatePrimaryVersion">updatePrimaryVersion(name, body=None, x__xgafv=None)</code>
<pre>Update the version of a CryptoKey that will be used in Encrypt.
Returns an error if called on an asymmetric key.
Args:
name: string, Required. The resource name of the CryptoKey to update. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.
"cryptoKeyVersionId": "A String", # Required. The id of the child CryptoKeyVersion to use as primary.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A CryptoKey represents a logical key that can be used for cryptographic
# operations.
#
# A CryptoKey is made up of one or more versions, which
# represent the actual key material used in cryptographic operations.
"rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service
# automatically rotates a key. Must be at least 24 hours and at most
# 876,000 hours.
#
# If rotation_period is set, next_rotation_time must also be set.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
"name": "A String", # Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
"labels": { # Labels with user-defined metadata. For more information, see
# [Labeling Keys](/kms/docs/labeling-keys).
"a_key": "A String",
},
"primary": { # A CryptoKeyVersion represents an individual cryptographic key, and the # Output only. A copy of the "primary" CryptoKeyVersion that will be used
# by Encrypt when this CryptoKey is given
# in EncryptRequest.name.
#
# The CryptoKey's primary version can be updated via
# UpdateCryptoKeyPrimaryVersion.
#
# Keys with purpose
# ENCRYPT_DECRYPT may have a
# primary. For other keys, this field will be omitted.
# associated key material.
#
# An ENABLED version can be
# used for cryptographic operations.
#
# For security reasons, the raw cryptographic key material represented by a
# CryptoKeyVersion can never be viewed or exported. It can only be used to
# encrypt, decrypt, or sign data when an authorized user or application invokes
# Cloud KMS.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
"importFailureReason": "A String", # Output only. The root cause of an import failure. Only present if
# state is
# IMPORT_FAILED.
"name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are
# performed with this CryptoKeyVersion.
"attestation": { # Contains an HSM-generated attestation about a key operation. For more # Output only. Statement that was generated and signed by the HSM at key
# creation time. Use this statement to verify attributes of the key as stored
# on the HSM, independently of Google. Only provided for key versions with
# protection_level HSM.
# information, see [Verifying attestations]
# (https://cloud.google.com/kms/docs/attest-key).
"content": "A String", # Output only. The attestation data provided by the HSM when the key
# operation was performed.
"format": "A String", # Output only. The format of the attestation data.
},
"state": "A String", # The current state of the CryptoKeyVersion.
"importJob": "A String", # Output only. The name of the ImportJob used to import this
# CryptoKeyVersion. Only present if the underlying key material was
# imported.
"generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# generated.
"importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material
# was imported.
"algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this
# CryptoKeyVersion supports.
"createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for # ExternalProtectionLevelOptions stores a group of additional fields for
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
# configuring a CryptoKeyVersion that are specific to the
# EXTERNAL protection level.
"externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents.
},
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
},
"versionTemplate": { # A CryptoKeyVersionTemplate specifies the properties to use when creating # A template describing settings for new CryptoKeyVersion instances.
# The properties of new CryptoKeyVersion instances created by either
# CreateCryptoKeyVersion or
# auto-rotation are controlled by this template.
# a new CryptoKeyVersion, either manually with
# CreateCryptoKeyVersion or
# automatically as a result of auto-rotation.
"protectionLevel": "A String", # ProtectionLevel to use when creating a CryptoKeyVersion based on
# this template. Immutable. Defaults to SOFTWARE.
"algorithm": "A String", # Required. Algorithm to use
# when creating a CryptoKeyVersion based on this template.
#
# For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both
# this field is omitted and CryptoKey.purpose is
# ENCRYPT_DECRYPT.
},
"purpose": "A String", # Immutable. The immutable purpose of this CryptoKey.
"createTime": "A String", # Output only. The time at which this CryptoKey was created.
"nextRotationTime": "A String", # At next_rotation_time, the Key Management Service will automatically:
#
# 1. Create a new version of this CryptoKey.
# 2. Mark the new version as primary.
#
# Key rotations performed manually via
# CreateCryptoKeyVersion and
# UpdateCryptoKeyPrimaryVersion
# do not affect next_rotation_time.
#
# Keys with purpose
# ENCRYPT_DECRYPT support
# automatic rotation. For other keys, this field must be omitted.
}</pre>
</div>
</body></html>