SASE Multitenant Notifications API

openapi: 3.0.2
info:
  title: Multi-Tenant Notifications API
  version: "1.0"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

  schemas:
    NotifProfileList:
      type: array
      items:
        $ref: '#/components/schemas/NotifProfile'
    NotifProfile:
      required:
      - profileName
      - opState
      - status
      - tenantList
      - notifTypeDetails
      - notifChannels
      type: object
      properties:
        id:
          description: Notification Profile Id
          type: string
          example: example-id
        profileName:
          description: Notification Profile Name
          type: string
          example: Corporate Gateway 25
        description:
          description: Notification Profile Description
          type: string
          example: Network configured incident threat network suspicious.
        opState:
          description: Notification Profile Operational State
          type: string
          enum:
          - ENABLED
          - DISABLED
          example: ENABLED
        status:
          description: Notification Profile Status
          type: string
          example: active
        tenantList:
          description: Input Tenant List
          type: array
          items:
            type: string
          example:
          - example-tenantList_item
          - example-tenantList_item
        excludeTenantList:
          description: List of excluded tenants
          type: array
          items:
            type: string
          example:
          - example-excludeTenantList_item
          - example-excludeTenantList_item
        notifTypeDetails:
          description: Notification Type Detail
          type: array
          items:
            $ref: '#/components/schemas/NotifTypeDetail'
          example:
          - type: INCIDENTS
            notifCategoryList:
            - name: Staging Firewall 26
              bestPractice: true
              subCategoryList:
              - {}
          - type: UPGRADES
            notifCategoryList:
            - name: Corporate Firewall 25
              bestPractice: false
              subCategoryList:
              - {}
            - name: Production Gateway 34
              bestPractice: true
              subCategoryList:
              - {}
        notifChannels:
          description: Notification Channel List
          type: array
          items:
            $ref: '#/components/schemas/NotifChannel'
          example:
          - name: Staging Policy 07
            type: WEBHOOK
            emailChannelDetails: {}
            webhookChannelDetails: {}
            template:
              name: Branch Sensor 49
              templateJson: example-templateJson
          - name: Primary Policy 34
            type: WEBHOOK
            emailChannelDetails: {}
            webhookChannelDetails: {}
            template:
              name: Staging Agent 97
              templateJson: example-templateJson
        successTenant:
          description: List of child tenants that got the incident profile
          type: array
          items:
            type: string
          example:
          - example-successTenant_item
          - example-successTenant_item
        failureTenant:
          description: List of child tenants that didn't get the incident profile
          type: array
          items:
            type: string

          example:
          - example-failureTenant_item
    NotifTypeDetail:
      required:
      - type
      - notifCategoryList
      type: object
      properties:
        type:
          description: Notification Type
          type: string
          enum:
          - INCIDENTS
          - UPGRADES
          - ANNOUNCEMENTS
          example: INCIDENTS
        notifCategoryList:
          description: List of notification type categories
          type: array
          items:
            $ref: '#/components/schemas/NotifCategoryDetail'
          example:
          - name: Production Agent 58
            bestPractice: true
            subCategoryList:
            - name: Production Gateway 95
              bestPractice: true
              needLicense: false
            - name: Production Gateway 70
              bestPractice: true
              needLicense: false
    NotifCategoryDetail:
      required:
      - name
      - bestPractice
      - subCategoryList
      type: object
      properties:
        name:
          description: Notification type category name
          type: string
          example: Corporate Policy 41
        bestPractice:
          description: Best practice flag for category
          type: boolean
          example: true
        subCategoryList:
          description: List of notification type sub-categories
          type: array
          items:
            $ref: '#/components/schemas/NotifSubCategoryDetail'
          example:
          - name: Production Agent 59
            bestPractice: true
            needLicense: false
          - name: Branch Sensor 85
            bestPractice: false
            needLicense: true
    NotifSubCategoryDetail:
      required:
      - name
      - bestPractice
      - needLicense
      type: object
      properties:
        name:
          description: Notification type sub-category name
          type: string
          example: Production Firewall 19
        bestPractice:
          description: Best practice flag for sub-category
          type: boolean
          example: false
        needLicense:
          description: Need license flag for sub-category
          type: boolean

          example: false
    NotifChannel:
      required:
      - name
      - type
      type: object
      properties:
        name:
          description: Notification channel name
          type: string
          example: Staging Firewall 47
        type:
          description: Notification channel type
          type: string
          enum:
          - EMAIL
          - WEBHOOK
          example: EMAIL
        emailChannelDetails:
          description: Email channel details
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EmailChannelDetails'
          example: &id001 {}
        webhookChannelDetails:
          description: Webhook channel details
          type: object
          additionalProperties:
            $ref: '#/components/schemas/WebhookChannelDetails'
          example: &id002 {}
        template:
          description: Channel output template
          type: object
          properties:
            name:
              description: Output channel template name
              type: string
              example: Corporate Agent 74
            templateJson:
              description: JSON describing the output channel template
              type: string
              example: example-templateJson
          example: &id003
            name: Production Policy 39
            templateJson: example-templateJson
    EmailChannelDetails:
      required:
      - emails
      type: object
      properties:
        emails:
          description: List of emails
          type: array
          items:
            $ref: '#/components/schemas/EmailDetails'
          example:
          - name: Corporate Agent 40
            emailId: '325822'
    EmailDetails:
      required:
      - name
      - emailId
      type: object
      properties:
        name:
          description: Email owner name
          type: string
          example: Branch Gateway 65
        emailId:
          description: Email id
          type: string
          example: '791552'
    WebhookChannelDetails:
      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
          example:
          - example-urls_item
        authType:
          description: Webhook Authentication Type
          type: string
          enum:
          - NO_AUTH
          - TOKEN
          example: TOKEN
        token:
          description: Webhook token value
          type: string

          example: 2a9211b7e1e46039628e349128c436ce
    NotifListApiReqBody:
      type: object
      properties:
        filters:
          description: List of output channels that the notification is sent on
          type: array
          items:
            $ref: '#/components/schemas/NotifFilter'
          example:
          - field: example-field
            values:
            - inApp
            - subCategory
        sortByList:
          description: List of output channels that the notification is sent on
          type: array
          items:
            $ref: '#/components/schemas/SortBy'
          example:
          - field: createdTime
            sortBy: ASC
        page:
          type: object
          description: Page number
          properties:
            num:
              type: integer
              description: Page number
              example: 768
            size:
              type: integer
              description: Page size
              example: 169
          example:
            num: 179
            size: 348
    NotifFilter:
      type: object
      properties:
        field:
          description: Filter field
          type: string
          example: example-field
        values:
          description: Filter field values
          type: array
          items:
            type: string
            enum:
            - readState
            - notifType
            - category
            - subCategory
            - inApp
          example:
          - readState
          - inApp
    SortBy:
      type: object
      properties:
        field:
          description: Sort field
          type: string
          enum:
          - createdTime
          - impactedTenantCount
          example: createdTime
        sortBy:
          description: Ascending or Descending
          type: string
          enum:
          - DESC
          - ASC

          example: ASC
    MtNotificationList:
      type: array
      items:
        $ref: '#/components/schemas/MtNotification'
    MtNotification:
      required:
      - name
      - body
      - aggKey
      - notifReadState
      - impactedTenants
      - impactedTenantCount
      - notifChannels
      type: object
      properties:
        id:
          description: Notification id
          type: string
          example: example-id
        name:
          description: Notification name
          type: string
          example: Branch Firewall 10
        body:
          description: Description of the notification
          type: string
          example: example-body
        action:
          description: Action to be taken on receiving the notification (if applicable)
          type: string
          example: deny
        createdTime:
          description: Notification creation time
          type: number
          example: 7.73
        aggKey:
          type: object
          description: Multi-Tenant Notification Aggregation Key
          properties:
            tag:
              $ref: '#/components/schemas/MtNotifAggKey'
          example:
            tag:
              tsgId: '609666'
              notifType: UPGRADES
              category: custom
              subCategory: standard
              inAppFlag: true
        impactedTenants:
          description: List of impacted tenants
          type: array
          items:
            type: string
          example:
          - example-impactedTenants_item
          - example-impactedTenants_item
        impactedTenantCount:
          description: Number of tenants impacted by the multi-tenant notification
          type: number
          example: 19.21
        notifReadState:
          $ref: '#/components/schemas/NotifReadState'
        notifChannels:
          description: List of output channels that the notification is sent on
          type: array
          items:
            $ref: '#/components/schemas/NotifChannel'
          example:
          - name: Staging Firewall 47
            type: EMAIL
            emailChannelDetails: *id001
            webhookChannelDetails: *id002
            template: *id003
          - name: Staging Firewall 47
            type: EMAIL
            emailChannelDetails: *id001
            webhookChannelDetails: *id002
            template: *id003
        notifType:
          description: Notification type
          type: string
          example: advanced
    MtNotifAggKey:
      required:
      - tsgId
      - notifType
      - category
      - subCategory
      - inAppFlag
      type: object
      properties:
        tsgId:
          description: TSG Id
          type: string
          example: '827783'
        notifType:
          description: Notification Type
          type: string
          enum:
          - INCIDENTS
          - UPGRADES
          - ANNOUNCEMENTS
          example: INCIDENTS
        category:
          description: Notification category - is associated with notification type
          type: string
          example: custom
        subCategory:
          description: Notification sub-category - is associated with notification type and notification category
          type: string
          example: custom
        inAppFlag:
          description: InApp Notification Flag
          type: boolean
          example: true
    NotifStateChangeApiBody:
      type: object
      properties:
        notifIds:
          description: List of notification IDs
          type: array
          items:
            type: string
          example:
          - example-notifIds_item
          - example-notifIds_item
        readState:
          $ref: '#/components/schemas/NotifReadState'
    NotifReadState:
      type: string
      description: Read state of the notification
      enum:
      - READ
      - UNREAD

security:
- bearerAuth: []
paths:
  /api/cloud/2.0/agg/notifications/profiles:
    get:
      tags:
      - NotificationProfiles
      summary: Palo Alto Networks List Notification Profiles
      description: |-
        ### Overview
        List the notification profiles associated with the current tenant.

        The current tenant TSG Id is obtained from the user JWT.

        This is a per-tenant query.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotifProfileList'
              examples:
                example-0:
                  summary: Empty Profile List
                  value:
                    data: []
                    requestId: 1e9a1f56-8ef4-47d3-864e-37b22c75bc84
                example-1:
                  summary: Profile List
                  value:
                    data:
                    - description: Notification Test Upgrades Announcements Profile
                      excludeTenantList: []
                      successTenant: []
                      failureTenant: []
                      status: SUCCESS
                      id: 1a0cb68d-5c91-4c5c-82ca-d0123a001fc7
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        webhookChannelDetails:
                          urls:
                          - www.test-3.webhook.com
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                      - emailChannelDetails:
                          emails:
                          - emailId: [email protected]
                            name: Swami Work
                          - emailId: [email protected]
                            name: Dummy email
                          - emailId: [email protected]
                            name: Pradnya Bapat
                        name: Email Channel
                        type: EMAIL
                      notifTypeDetails:
                      - notifCategoryList:
                        - bestPractice: false
                          name: Dataplane
                          subCategoryList:
                          - bestPractice: false
                            name: In Progress
                        type: UPGRADES
                      - notifCategoryList:
                        type: ANNOUNCEMENTS
                      opState: ENABLED
                      profileName: Upgrades Announcements Profile
                      tenantList:
                      - '1681604441'
                      - '1037879421'
                      - '1721119209'
                    - description: Notification Test Upgrades Profile
                      excludeTenantList: []
                      successTenant: []
                      failureTenant: []
                      status: SUCCESS
                      id: 1cdabde0-01d6-4727-912b-e53bc620a82f
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        webhookChannelDetails:
                          urls:
                          - www.test-3.webhook.com
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                      - emailChannelDetails:
                          emails:
                          - emailId: [email protected]
                            name: Swami Work
                          - emailId: [email protected]
                            name: Dummy email
                          - emailId: [email protected]
                            name: Pradnya Bapat
                        name: Email Channel
                        type: EMAIL
                      notifTypeDetails:
                      - notifCategoryList:
                        - bestPractice: false
                          name: Dataplane
                          subCategoryList:
                          - bestPractice: true
                            name: Error
                        type: UPGRADES
                      opState: ENABLED
                      profileName: Upgrades Profile
                      tenantList:
                      - '1681604441'
                      - '1037879421'
                      - '1721119209'
                    requestId: b0da2438-92b0-4294-8a7e-31a356b746c7
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - NotificationProfiles
      summary: Palo Alto Networks Create a Notification Profile
      description: |-
        ### Overview
        Create a new notification profile by providing the profile name and the inputs & outputs used by the profile

        The inputs are:
        - Impacted tenants, notification type, notification categories & sub-categories

        The outputs are:
        - Output channels

        The newly created notification profile is diabled by default.

        The profile must be explicitly enabled for the profile to act on notification inputs and generate notifications.

      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotifProfile'
            examples:
              Upgrades Profile:
                value:
                  profileName: Upgrades_Profile
                  opState: ENABLED
                  description: Notification Test Upgrades Profile
                  tenantList:
                  - '1681604441'
                  - '1721119209'
                  - '1037879421'
                  notifTypeDetails:
                  - type: UPGRADES
                    notifCategoryList:
                    - name: Dataplane
                      subCategoryList:
                      - name: Error
                  notifChannels:
                  - name: Webhook Channel
                    type: WEBHOOK
                    webhookChannelDetails:
                      urls:
                      - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                      - www.test-3.webhook.com
                      authType: NO_AUTH
                  - name: Email Channel
                    type: EMAIL
                    emailChannelDetails:
                      emails:
                      - name: Pradnya Bapat
                        emailId: [email protected]
                      - name: Swami Work
                        emailId: [email protected]
              Announcements Profile:
                value:
                  profileName: Announcements_Profile
                  opState: DISABLED
                  description: Notification Test Announcements Profile
                  tenantList:
                  - '1681604441'
                  - '1721119209'
                  - '1037879421'
                  notifTypeDetails:
                  - type: ANNOUNCEMENTS
                  notifChannels:
                  - name: Webhook Channel
                    type: WEBHOOK
                    webhookChannelDetails:
                      urls:
                      - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                      - www.test-3.webhook.com
                      authType: NO_AUTH
                  - name: Email Channel
                    type: EMAIL
                    emailChannelDetails:
                      emails:
                      - name: Swami Work
                        emailId: [email protected]
              Incidents Profile:
                value:
                  profileName: Incidents_Profile
                  opState: DISABLED
                  description: Notification Test Incidents Profile
                  tenantList:
                  - '1681604441'
                  - '1721119209'
                  - '1037879421'
                  notifTypeDetails:
                  - type: INCIDENTS
                    notifCategoryList:
                    - name: RN
                      subCategoryList:
                      - name: INC_RN_SITE_DOWN
                      - name: INC_RN_PRIMARY_WAN_BGP_DOWN
                  notifChannels:
                  - name: Webhook Channel
                    type: WEBHOOK
                    webhookChannelDetails:
                      urls:
                      - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                      - www.test-3.webhook.com
                      authType: NO_AUTH
                  - name: Email Channel
                    type: EMAIL
                    emailChannelDetails:
                      emails:
                      - name: Swami Work
                        emailId: [email protected]
              Announcements and Upgrades Profile:
                value:
                  profileName: Announcements_Upgrades_Profile
                  opState: DISABLED
                  description: Notification Test Profile
                  tenantList:
                  - '1681604441'
                  - '1721119209'
                  - '1037879421'
                  notifTypeDetails:
                  - type: ANNOUNCEMENTS
                  - type: UPGRADES
                    notifCategoryList:
                    - name: Dataplane
                      subCategoryList:
                      - name: Scheduled
                  notifChannels:
                  - name: Webhook Channel
                    type: WEBHOOK
                    webhookChannelDetails:
                      urls:
                      - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                      - www.test-3.webhook.com
                      authType: NO_AUTH
                  - name: Email Channel
                    type: EMAIL
                    emailChannelDetails:
                      emails:
                      - name: Swami Work
                        emailId: [email protected]
              Profile With Token in Webhook:
                value:
                  profileName: Upgrades_Profile
                  opState: DISABLED
                  description: Notification Test Upgrades Profile
                  tenantList:
                  - '1681604441'
                  - '1721119209'
                  - '1037879421'
                  notifTypeDetails:
                  - type: UPGRADES
                    notifCategoryList:
                    - name: Dataplane
                      subCategoryList:
                      - name: Error
                  notifChannels:
                  - name: Webhook Channel
                    type: WEBHOOK
                    webhookChannelDetails:
                      urls:
                      - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                      - www.test-3.webhook.com
                      authType: TOKEN
                      token: '*****'

      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotifProfile'
              examples:
                example-0:
                  summary: Upgrade Profile
                  value:
                    requestId: 00aff65a-9768-4365-842f-741e4a1095d6
                    data:
                      id: 0616b91f-21df-47a4-b8ef-311399b762c3
                      profileName: Upgrades_Profile
                      opState: ENABLED
                      description: Notification Test Upgrades Profile
                      tenantList:
                      - '1681604441'
                      - '1721119209'
                      - '1037879421'
                      excludeTenantList: []
                      successTenant: []
                      failureTenant: []
                      status: SUCCESS
                      notifTypeDetails:
                      - type: UPGRADES
                        notifCategoryList:
                        - name: Dataplane
                          bestPractice: false
                          subCategoryList:
                          - name: Error
                            bestPractice: true
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        emailChannelDetails:
                        webhookChannelDetails:
                          urls:
                          - www.test-3.webhook.com
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                          basicAuth:
                          token:
                        template:
                      - name: Email Channel
                        type: EMAIL
                        emailChannelDetails:
                          emails:
                          - name: Swami Work
                            emailId: [email protected]
                          - name: Pradnya Bapat
                            emailId: [email protected]
                        webhookChannelDetails:
                        template:
                    error:
                example-1:
                  summary: Announcement Profile
                  value:
                    requestId: 00aff65a-9768-4365-842f-741e4a1095d6
                    data:
                      id: 0616b91f-21df-47a4-b8ef-311399b762c3
                      profileName: Announcements_Profile
                      opState: DISABLED
                      description: Notification Test Announcements Profile
                      tenantList:
                      - '1681604441'
                      - '1721119209'
                      - '1037879421'
                      excludeTenantList: []
                      successTenant: []
                      failureTenant: []
                      status: SUCCESS
                      notifTypeDetails:
                      - type: ANNOUNCEMENTS
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        emailChannelDetails:
                        webhookChannelDetails:
                          urls:
                          - www.test-3.webhook.com
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                          basicAuth:
                          token:
                        template:
                      - name: Email Channel
                        type: EMAIL
                        emailChannelDetails:
                          emails:
                          - name: Swami Work
                            emailId: [email protected]
                          - name: Pradnya Bapat
                            emailId: [email protected]
                        webhookChannelDetails:
                        template:
                    error:
                example-2:
                  summary: Incidents Profile
                  value:
                    data:
                      description: Notification Test Incidents Profile
                      excludeTenantList: []
                      successTenant: []
                      failureTenant: []
                      status: SUCCESS
                      id: 1cdabde0-01d6-4727-912b-e53bc620a82f
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        webhookChannelDetails:
                          urls:
                          - www.test-3.webhook.com
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                      - emailChannelDetails:
                          emails:
                          - emailId: [email protected]
                            name: Swami Work
                          - emailId: [email protected]
                            name: Pradnya Bapat
                        name: Email Channel
                        type: EMAIL
                      notifTypeDetails:
                      - notifCategoryList:
                        - bestPractice: false
                          name: RN
                          subCategoryList:
                          - bestPractice: true
                            name: INC_SC_SITE_DOWN
                          - bestPractice: true
                            name: INC_SC_PRIMARY_WAN_BGP_DOWN
                        type: INCIDENTS
                      opState: DISABLED
                      profileName: Incidents_Profile
                      tenantList:
                      - '1681604441'
                      - '1037879421'
                      - '1721119209'
                    requestId: 18ad77fd-594c-4a35-8a3b-14bf6a63d6ca
                example-3:
                  summary: Announcements and Upgrade Profile
                  value:
                    requestId: cc87ff93-9a00-4950-ac2c-f17db9586651
                    data:
                      id: 2c12cfa3-5428-40c4-bced-b6671e96e476
                      profileName: Announcements_Upgrades_Profile
                      opState: DISABLED
                      description: Notification Test Profile
                      tenantList:
                      - '1127223253'
                      - '1091039496'
                      - '1418299734'
                      excludeTenantList: []
                      notifTypeDetails:
                      - type: ANNOUNCEMENTS
                        notifCategoryList: []
                      - type: UPGRADES
                        notifCategoryList:
                        - name: Dataplane
                          bestPractice: false
                          subCategoryList:
                          - name: Scheduled
                            bestPractice: true
                      notifChannels:
                      - name: Webhook Channel
                        type: WEBHOOK
                        emailChannelDetails:
                        webhookChannelDetails:
                          urls:
                          - https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6
                          authType: NO_AUTH
                        template:
                      - name: Email Channel
                        type: EMAIL
                        emailChannelD

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-sase-multitenant-notifications-api-openapi-original.yml