GetApiKeyResponseObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-get-api-key-response-obj-schema.json",
  "title": "GetApiKeyResponseObj",
  "description": "Response object that provides detailed information about an existing API key, including its current status, capabilities, and permissions.\n",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azupay-api-keys-api-openapi.yml#/components/schemas/GetApiKeyResponseObj",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "keyID": {
      "type": "string",
      "description": "A unique identifier for the API key. This ID is used to reference and manage the key programmatically.\n"
    },
    "hmacEnabled": {
      "type": "boolean",
      "description": "Indicates whether HMAC-based authentication is enabled for this API key. If true, requests authenticated with this key must be signed using HMAC.\n"
    },
    "enabled": {
      "type": "boolean",
      "description": "Represents whether the API key is currently active and allowed to be used. If set to false, the key is considered disabled and cannot be used for authentication.\n"
    },
    "permittedOperations": {
      "type": "array",
      "description": "A list of operations that the API key is authorized to perform. These may correspond to specific API actions, endpoints, or permission scopes.\n",
      "items": {
        "type": "string"
      }
    }
  }
}