MtNotificationList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MtNotificationList",
  "description": "MtNotificationList schema from Multi-Tenant Notifications API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-notifications-api-mt-notification-list-schema.json",
  "type": "array",
  "items": {
    "required": [
      "name",
      "body",
      "aggKey",
      "notifReadState",
      "impactedTenants",
      "impactedTenantCount",
      "notifChannels"
    ],
    "type": "object",
    "properties": {
      "id": {
        "description": "Notification id",
        "type": "string"
      },
      "name": {
        "description": "Notification name",
        "type": "string"
      },
      "body": {
        "description": "Description of the notification",
        "type": "string"
      },
      "action": {
        "description": "Action to be taken on receiving the notification (if applicable)",
        "type": "string"
      },
      "createdTime": {
        "description": "Notification creation time",
        "type": "number"
      },
      "aggKey": {
        "type": "object",
        "description": "Multi-Tenant Notification Aggregation Key",
        "properties": {
          "tag": {
            "required": [
              "tsgId",
              "notifType",
              "category",
              "subCategory",
              "inAppFlag"
            ],
            "type": "object",
            "properties": {
              "tsgId": {
                "description": "TSG Id",
                "type": "string"
              },
              "notifType": {
                "description": "Notification Type",
                "type": "string",
                "enum": [
                  "INCIDENTS",
                  "UPGRADES",
                  "ANNOUNCEMENTS"
                ]
              },
              "category": {
                "description": "Notification category - is associated with notification type",
                "type": "string"
              },
              "subCategory": {
                "description": "Notification sub-category - is associated with notification type and notification category",
                "type": "string"
              },
              "inAppFlag": {
                "description": "InApp Notification Flag",
                "type": "boolean"
              }
            }
          }
        }
      },
      "impactedTenants": {
        "description": "List of impacted tenants",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "impactedTenantCount": {
        "description": "Number of tenants impacted by the multi-tenant notification",
        "type": "number"
      },
      "notifReadState": {
        "type": "string",
        "description": "Read state of the notification",
        "enum": [
          "READ",
          "UNREAD"
        ]
      },
      "notifChannels": {
        "description": "List of output channels that the notification is sent on",
        "type": "array",
        "items": {
          "required": [
            "name",
            "type"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Notification channel name",
              "type": "string"
            },
            "type": {
              "description": "Notification channel type",
              "type": "string",
              "enum": [
                "EMAIL",
                "WEBHOOK"
              ]
            },
            "emailChannelDetails": {
              "description": "Email channel details",
              "type": "object",
              "additionalProperties": {
                "required": [
                  "emails"
                ],
                "type": "object",
                "properties": {
                  "emails": {
                    "description": "List of emails",
                    "type": "array",
                    "items": {
                      "required": [
                        "name",
                        "emailId"
                      ],
                      "type": "object",
                      "properties": {
                        "name": {
                          "description": "Email owner name",
                          "type": "string"
                        },
                        "emailId": {
                          "description": "Email id",
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            },
            "webhookChannelDetails": {
              "description": "Webhook channel details",
              "type": "object",
              "additionalProperties": {
                "required": [
                  "urls",
                  "authType",
                  "token"
                ],
                "type": "object",
                "properties": {
                  "urls": {
                    "description": "List of Webhook URLs - do not include token in the URL",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "authType": {
                    "description": "Webhook Authentication Type",
                    "type": "string",
                    "enum": [
                      "NO_AUTH",
                      "TOKEN"
                    ]
                  },
                  "token": {
                    "description": "Webhook token value",
                    "type": "string"
                  }
                }
              }
            },
            "template": {
              "description": "Channel output template",
              "type": "object",
              "properties": {
                "name": {
                  "description": "Output channel template name",
                  "type": "string"
                },
                "templateJson": {
                  "description": "JSON describing the output channel template",
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "notifType": {
        "description": "Notification type",
        "type": "string"
      }
    }
  }
}