Amazon Payment Cryptography · JSON Structure

Openapi Key Attributes Structure

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

Type: object Properties: 4 Required: 4
CryptographyFinancial ServicesPayment ProcessingPCI

KeyAttributes is a JSON Structure definition published by Amazon Payment Cryptography, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

KeyAlgorithm KeyClass KeyModesOfUse KeyUsage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-payment-cryptography/refs/heads/main/json-structure/openapi-key-attributes-structure.json",
  "name": "KeyAttributes",
  "description": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.",
  "type": "object",
  "properties": {
    "KeyAlgorithm": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyAlgorithm"
        },
        {
          "description": "<p>The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.</p> <p>For symmetric keys, Amazon Web Services Payment Cryptography supports <code>AES</code> and <code>TDES</code> algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports <code>RSA</code> and <code>ECC_NIST</code> algorithms.</p>"
        }
      ]
    },
    "KeyClass": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyClass"
        },
        {
          "description": "The type of Amazon Web Services Payment Cryptography key to create, which determines the classi\ufb01cation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair."
        }
      ]
    },
    "KeyModesOfUse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyModesOfUse"
        },
        {
          "description": "The list of cryptographic operations that you can perform using the key."
        }
      ]
    },
    "KeyUsage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyUsage"
        },
        {
          "description": "The cryptographic usage of an Amazon Web Services Payment Cryptography key as de\ufb01ned in section A.5.2 of the TR-31 spec."
        }
      ]
    }
  },
  "required": [
    "KeyAlgorithm",
    "KeyClass",
    "KeyModesOfUse",
    "KeyUsage"
  ]
}