Automated commit 'Merge pull request #1569 from sailpoint/pltcore/4362

update outdated notification API text' by github action: 8022763439

idn/beta/paths/notification-preferences.yaml

@@ -6,13 +6,13 @@ get:
   description: >-
     Returns the notification preferences for tenant.  Note that if the key doesn't exist, then a 404 will be returned.
 
-    Request will require the following legacy roles:  ORG_ADMIN and API
-  # security:
-  #   - oauth2: [ORG_ADMIN,API]
+  security:
+  - UserContextAuth: [ idn:notification-preferences:read ]
   parameters:
     - in: path
       name: key
       required: true
+      example: cloud_manual_work_item_summary
       schema:
         type: string
       description: The notification key.
@@ -33,28 +33,24 @@ get:
       $ref: '../../v3/responses/404.yaml'
     '429':
       $ref: '../../v3/responses/429.yaml'
+    '500':
+      $ref: '../../v3/responses/500.yaml'
 put:
   operationId: putNotificationPreference
   tags:
     - Notifications
-  summary: Overwrite the preferences for the given notification key.
+  summary: Overwrite preferences notification key.
   description: >- 
-    In the notification world, a notification flows through these salient stages - 
-     1. Interest matching, 
-     2. Preferences 
-     3. Template Rendering. 
-    
-    The default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for 
-    admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as 
-    we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. 
+    Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown.
+
+  security:
+  - UserContextAuth: [ idn:notification-preferences:create ]
 
-    Request will require the following legacy roles:  ORG_ADMIN and API
-  # security:
-  #   - oauth2: [ORG_ADMIN,API]
   parameters:
     - in: path
       name: key
       required: true
+      example: cloud_manual_work_item_summary
       schema:
         type: string
       description: The notification key.
@@ -81,6 +77,5 @@ put:
       $ref: '../../v3/responses/404.yaml'
     '429':
       $ref: '../../v3/responses/429.yaml'
-
-
-
+    '500':
+      $ref: '../../v3/responses/500.yaml'

idn/beta/paths/notification-template-context.yaml

@@ -4,15 +4,12 @@ get:
     - Notifications
   summary: Get Notification Template Context
   description: >-
-    The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. 
-    The data-store where this information is retrieved is  called "Global Context" (a.k.a. notification template context). It defines a set of attributes
+    The notification service maintains metadata to construct the notification templates or supply any information during the event propagation.
+    The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
      that will be available per tenant (organization).
-    
-    Regarding authorization, the access token contains the tenant and will grant access to the one requested.
 
-    Requires the following security scope:  idn:notification-templates:read
-  # security:
-  #   - oauth2: [idn:notification-templates:read]
+  security:
+  - UserContextAuth: [ idn:notification-templates:read ]
 
   responses:
     '200':

idn/beta/paths/notification-template-defaults.yaml

@@ -4,14 +4,17 @@ get:
     - Notifications
   summary: List Notification Template Defaults
   description: >-
-    This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates.
+    This lists the default templates used for notifications, such as emails from IdentityNow.
+  security:
+  - UserContextAuth: [ idn:notification-template-defaults:read ]
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
     - in: query
       name: filters
       schema:
         type: string
+        example: key eq "cloud_manual_work_item_summary"
       description: >-
         Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
 

idn/beta/paths/notification-templates-bulk-delete.yaml

@@ -4,7 +4,9 @@ post:
     - Notifications
   summary: Bulk Delete Notification Templates
   description: >-
-    This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.
+    This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.
+  security:
+  - UserContextAuth: [ idn:notification-templates:delete ]
   requestBody:
     required: true
     content:
@@ -25,4 +27,4 @@ post:
     '429':
       $ref: '../../v3/responses/429.yaml'
     '500':
-      $ref: '../../v3/responses/500.yaml'
+      $ref: '../../v3/responses/500.yaml'

idn/beta/paths/notification-templates.yaml

@@ -4,7 +4,9 @@ get:
     - Notifications
   summary: List Notification Templates
   description: >-
-    This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates.
+    This lists the templates that you have modified for your site.
+  security:
+  - UserContextAuth: [ idn:notification-templates:read ]
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
@@ -58,6 +60,8 @@ post:
     
     You can also use this endpoint to update a template.  First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint.  
     Modify the fields you want to change and submit the POST request when ready.
+  security:
+  - UserContextAuth: [ idn:notification-templates:create]
   requestBody:
     required: true
     content: