Cloud Keys 2020 Kotlin Edition

Questions / Feedback?

AzureKey Type

An Azure Key Vault key.

Remarks

This type represents an Azure Key Vault key.

Fields

CreationDate
Long

The creation date of the key.

This field reflects the creation date of the key, in seconds since the Unix epoch.

DeletionDate
Long

The deletion date of the key.

This field reflects the deletion date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.

Enabled
Boolean

Whether the key is enabled.

This field reflects whether the key is currently enabled.

ExpiryDate
Long

The expiration date of the key.

This field reflects the expiration date of the key, in seconds since the Unix epoch, or -1 if the key does not expire.

A key can only be used for the Decrypt, Verify, and UnwrapKey operations after its expiry date.

KeyOps
String?

The operation that the key may be used for.

This field reflects a comma-separated list of operations that they key may be used for. Possible values are:

  • encrypt
  • decrypt
  • sign
  • verify
  • wrapKey
  • unwrapKey

KeyType
String?

The key's type.

This field reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values for this field are shown in the first two columns of the following table:

Software-based HSM-based Description
EC_P256 EC_HSM_P256 The NIST P-256 curve (SECP256R1).
EC_P256K EC_HSM_P256K The SECP256K1 curve.
EC_P384 EC_HSM_P384 The NIST P-384 curve (SECP384R1).
EC_P521 EC_HSM_P521 The NIST P-521 curve (SECP521R1).
RSA_2048 RSA_HSM_2048 2048-bit RSA key.
RSA_3072 RSA_HSM_3072 3072-bit RSA key.
RSA_4096 RSA_HSM_4096 4096-bit RSA key.

Name
String?

The name of the key.

This field reflects the name of the key.

NotBeforeDate
Long

The 'not before' date of the key.

This field reflects the "not before" date of the key, in seconds since the Unix epoch, or -1 if the key doesn't have an explicit "not before" date.

A key can only be used for the Decrypt, Verify, and UnwrapKey operations prior to its "not before" date.

PublicKey
String?

The key's public key.

This field reflects the public key of the key, in PEM format.

PurgeDate
Long

The purge date of the key.

This field reflects the purge (i.e., permanent deletion) date of the key, in seconds since the Unix epoch, or -1 if the key has not been deleted.

RecoverableDays
Int

The number of days the key will be recoverable if it gets deleted.

This field reflects the number of days that the key will be recoverable for if it gets deleted.

Note that this field's value is based on the retention policy of the currently-selected Vault; it will not change after the key has actually been deleted.

RecoveryLevel
String?

The key's ability to be recovered and/or purged if it gets deleted.

This field reflects the key's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:

  • CustomizedRecoverable
  • CustomizedRecoverable+ProtectedSubscription
  • CustomizedRecoverable+Purgeable
  • Purgeable
  • Recoverable
  • Recoverable+ProtectedSubscription
  • Recoverable+Purgeable

UpdateDate
Long

The update date of the key.

This field reflects the update date of the key, in seconds since the Unix epoch.

VersionId
String?

The version Id of the key.

This field reflects the version Id of the key.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Keys 2020 Kotlin Edition - Version 20.0 [Build 7876]