apiKeysProvisionResponseObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-api-keys-provision-response-obj-schema.json",
  "title": "apiKeysProvisionResponseObj",
  "description": "Response object returned upon successful provisioning of a new API key. Contains the newly created API key details including credentials 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/apiKeysProvisionResponseObj",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "keyID": {
      "type": "string",
      "description": "A unique identifier assigned to the newly created API key.\n"
    },
    "apiKey": {
      "type": "string",
      "description": "The actual API key string that clients will use for authentication. This should be stored securely by the client, as it is only returned once.\n"
    },
    "hmacKey": {
      "type": "string",
      "description": "The HMAC secret key associated with the API key, used for request signing. Like the apiKey, this should be treated as sensitive and stored securely.\n"
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether the newly provisioned API key is active and usable.\n"
    },
    "permittedOperations": {
      "type": "array",
      "description": "A list of operations or permissions granted to this API key. These define what actions can be performed using the key.\n",
      "items": {
        "type": "string"
      }
    }
  }
}