KeyAttributes

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.

CryptographyFinancial-ServicesPayment ProcessingPCI

Properties

Name Type Description
KeyAlgorithm object
KeyClass object
KeyModesOfUse object
KeyUsage object
View JSON Schema on GitHub

JSON Schema

openapi-key-attributes-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-payment-cryptography/refs/heads/main/json-schema/openapi-key-attributes-schema.json",
  "title": "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"
  ]
}