Skip to main content

CodeSignKeyPairValues

Code Sign Key Pair Values

type CodeSignKeyPairValues {
  label: String!
  status: CodeSignObjectStatus!
  statusMessage: String
  object: KeyPair
  historicObjects: [KeyPair!]
  discardedObjects: [KeyPair!]
  location: KeyStorageLocation
  driver: KeyStorageDriver
  keyUsage: KeyUsage
  parameterSet: KeyParameterSet!
  validity: Duration!
}

Fields​

CodeSignKeyPairValues.label ● String! non-null scalar​

A read-only idenfitier to access this key pair to perform cryptographic operations.

CodeSignKeyPairValues.status ● CodeSignObjectStatus! non-null enum​

A value that represents the current status of the cryptographic object that has been created using this pattern.

CodeSignKeyPairValues.statusMessage ● String scalar​

A human readable message that provides additional detail about the current status of the cryptographic object, or null if no extra detail is available.

CodeSignKeyPairValues.object ● KeyPair object​

A reference to the resulting KeyPair cryptographic object, or null if it has not yet been minted.

CodeSignKeyPairValues.historicObjects ● [KeyPair!] list object​

When a KeyPair is rotated the now historic KeyPair may be placed in this list if it is still accessible.

CodeSignKeyPairValues.discardedObjects ● [KeyPair!] list object​

A set of objects, which should be deleted.

Any Key Pair which is no longer needed should be added to this list, and written to the datastore before attempting to delete it. This ensures that the Signing Key will remain in a functional state even if errors are encountered when interacting with the Key Storage Driver.

CodeSignKeyPairValues.location ● KeyStorageLocation object​

The KeyStorageLocation that should be used when minting the initial KeyPair or when performing key rotation.

A key will not be minted until a valid location and driver are set.

CodeSignKeyPairValues.driver ● KeyStorageDriver object​

The KeyStorageDriver that hosts the KeyStorageLocation that should be used when minting the initial KeyPair or when performing key rotation.

A key will not be minted until a valid location and driver are set.

CodeSignKeyPairValues.keyUsage ● KeyUsage object​

The intended usage of the key

CodeSignKeyPairValues.parameterSet ● KeyParameterSet! non-null enum​

The desired key type, along with type specific parameters

CodeSignKeyPairValues.validity ● Duration! non-null scalar​

The time period after a key has been minted or rotated that it should be considered valid.

Member Of​

CodeSignSigningKeyObjects object