ApiKeyCreated

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/flashdata-dev/json-schema/flashdata-dev-api-key-created-schema.json",
  "title": "ApiKeyCreated",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/flashdata-dev-api-keys-api-openapi.yml#/components/schemas/ApiKeyCreated",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "apiKey",
    "secret"
  ],
  "properties": {
    "apiKey": {
      "$ref": "#/$defs/ApiKey"
    },
    "secret": {
      "type": "string",
      "readOnly": true,
      "pattern": "^fd_(?:(?:test|live)_)?[A-Za-z0-9_-]{43}$",
      "description": "Plaintext secret returned only by this create/rotate transaction. Newly issued secrets use the `fd_` prefix. Previously issued `fd_test_` and `fd_live_` secrets still authenticate. An authenticated replay with the same Idempotency-Key and request body may receive the same KMS-encrypted response for five minutes; it is not recoverable afterward.",
      "x-secret-reveal": "once"
    }
  },
  "$defs": {
    "ApiKey": {
      "type": "object",
      "description": "API key details. A key remains active until scheduledRevocationAt when revocation is scheduled.",
      "additionalProperties": false,
      "required": [
        "id",
        "name",
        "prefix",
        "last4",
        "scopes",
        "status",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^key_"
        },
        "name": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        },
        "last4": {
          "type": "string",
          "minLength": 4,
          "maxLength": 4
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "revoked",
            "expired"
          ]
        },
        "lastUsedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "expiresAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "scheduledRevocationAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "Planned revocation time for an overlapping retiring key; null for a primary or immediately revoked key."
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}