Class CryptoKey

A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

Inheritance
object
CryptoKey
Implements
Inherited Members
Namespace: Google.Apis.CloudKMS.v1.Data
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class CryptoKey : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time at which this CryptoKey was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CryptoKeyBackend

Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.

Declaration
[JsonProperty("cryptoKeyBackend")]
public virtual string CryptoKeyBackend { get; set; }
Property Value
Type Description
string

DestroyScheduledDuration

Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.

Declaration
[JsonProperty("destroyScheduledDuration")]
public virtual object DestroyScheduledDuration { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ImportOnly

Immutable. Whether this key may contain imported versions only.

Declaration
[JsonProperty("importOnly")]
public virtual bool? ImportOnly { get; set; }
Property Value
Type Description
bool?

KeyAccessJustificationsPolicy

Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed.

Declaration
[JsonProperty("keyAccessJustificationsPolicy")]
public virtual KeyAccessJustificationsPolicy KeyAccessJustificationsPolicy { get; set; }
Property Value
Type Description
KeyAccessJustificationsPolicy

Labels

Labels with user-defined metadata. For more information, see Labeling Keys.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NextRotationTime

object representation of NextRotationTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NextRotationTimeDateTimeOffset instead.")]
public virtual object NextRotationTime { get; set; }
Property Value
Type Description
object

NextRotationTimeDateTimeOffset

DateTimeOffset representation of NextRotationTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NextRotationTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NextRotationTimeRaw

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.

Declaration
[JsonProperty("nextRotationTime")]
public virtual string NextRotationTimeRaw { get; set; }
Property Value
Type Description
string

Primary

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.

Declaration
[JsonProperty("primary")]
public virtual CryptoKeyVersion Primary { get; set; }
Property Value
Type Description
CryptoKeyVersion

Purpose

Immutable. The immutable purpose of this CryptoKey.

Declaration
[JsonProperty("purpose")]
public virtual string Purpose { get; set; }
Property Value
Type Description
string

RotationPeriod

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.

Declaration
[JsonProperty("rotationPeriod")]
public virtual object RotationPeriod { get; set; }
Property Value
Type Description
object

VersionTemplate

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.

Declaration
[JsonProperty("versionTemplate")]
public virtual CryptoKeyVersionTemplate VersionTemplate { get; set; }
Property Value
Type Description
CryptoKeyVersionTemplate

Implements