KeyCreateParameters

The key create parameters.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
kty	string	The type of key to create.
key_size	integer	The key size in bits. For example, 2048, 3072, or 4096 for RSA.
key_ops	array	JSON web key operations.
attributes	object
tags	object	Application-specific metadata.
crv	string	Elliptic curve name (for EC key types).
release_policy	object
exportable	boolean	Whether the private key can be exported.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyCreateParameters",
  "title": "KeyCreateParameters",
  "type": "object",
  "description": "The key create parameters.",
  "properties": {
    "kty": {
      "type": "string",
      "description": "The type of key to create.",
      "enum": [
        "EC",
        "EC-HSM",
        "RSA",
        "RSA-HSM",
        "oct",
        "oct-HSM"
      ],
      "example": "EC"
    },
    "key_size": {
      "type": "integer",
      "description": "The key size in bits. For example, 2048, 3072, or 4096 for RSA.",
      "example": 10
    },
    "key_ops": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "encrypt",
          "decrypt",
          "sign",
          "verify",
          "wrapKey",
          "unwrapKey",
          "import",
          "export"
        ]
      },
      "description": "JSON web key operations.",
      "example": []
    },
    "attributes": {
      "$ref": "#/components/schemas/KeyAttributes"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Application-specific metadata.",
      "example": "example_value"
    },
    "crv": {
      "type": "string",
      "description": "Elliptic curve name (for EC key types).",
      "enum": [
        "P-256",
        "P-384",
        "P-521",
        "P-256K"
      ],
      "example": "P-256"
    },
    "release_policy": {
      "$ref": "#/components/schemas/KeyReleasePolicy"
    },
    "exportable": {
      "type": "boolean",
      "description": "Whether the private key can be exported.",
      "example": true
    }
  },
  "required": [
    "kty"
  ]
}