NotifProfile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NotifProfile",
  "description": "NotifProfile 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-notif-profile-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "description": "Notification Profile Id",
      "type": "string"
    },
    "profileName": {
      "description": "Notification Profile Name",
      "type": "string"
    },
    "description": {
      "description": "Notification Profile Description",
      "type": "string"
    },
    "opState": {
      "description": "Notification Profile Operational State",
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ]
    },
    "status": {
      "description": "Notification Profile Status",
      "type": "string"
    },
    "tenantList": {
      "description": "Input Tenant List",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "excludeTenantList": {
      "description": "List of excluded tenants",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notifTypeDetails": {
      "description": "Notification Type Detail",
      "type": "array",
      "items": {
        "required": [
          "type",
          "notifCategoryList"
        ],
        "type": "object",
        "properties": {
          "type": {
            "description": "Notification Type",
            "type": "string",
            "enum": [
              "INCIDENTS",
              "UPGRADES",
              "ANNOUNCEMENTS"
            ]
          },
          "notifCategoryList": {
            "description": "List of notification type categories",
            "type": "array",
            "items": {
              "required": [
                "name",
                "bestPractice",
                "subCategoryList"
              ],
              "type": "object",
              "properties": {
                "name": {
                  "description": "Notification type category name",
                  "type": "string"
                },
                "bestPractice": {
                  "description": "Best practice flag for category",
                  "type": "boolean"
                },
                "subCategoryList": {
                  "description": "List of notification type sub-categories",
                  "type": "array",
                  "items": {
                    "required": [
                      "name",
                      "bestPractice",
                      "needLicense"
                    ],
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "Notification type sub-category name",
                        "type": "string"
                      },
                      "bestPractice": {
                        "description": "Best practice flag for sub-category",
                        "type": "boolean"
                      },
                      "needLicense": {
                        "description": "Need license flag for sub-category",
                        "type": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "notifChannels": {
      "description": "Notification Channel List",
      "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"
              }
            }
          }
        }
      }
    },
    "successTenant": {
      "description": "List of child tenants that got the incident profile",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "failureTenant": {
      "description": "List of child tenants that didn't get the incident profile",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "profileName",
    "opState",
    "status",
    "tenantList",
    "notifTypeDetails",
    "notifChannels"
  ]
}