Automated commit 'Merge pull request #45 from sailpoint/NEROCKET-1747

NEROCKET-1747 updating audit query docs to reflect objects, subject t…' by github action: 11280772872

nerm/paths/audit_events.yaml

@@ -1,6 +1,14 @@
 post:
   summary: Query for Audit events
-  description: This endpoint provides a search engine for Audit Events by optionally combining entity_type, type, and subject_id to narrow down the audit events. An Entity Type of Profile links up to the AuditableProfile types. An Entity Type of WorkflowSession links up to the AuditableWorkflow types. An Entity Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Entity Types link up to the ActiveRecord types (configuration changes).
+  description: >
+    This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. An Subject Type of Profile links up to the AuditableProfile types. An Subject Type of WorkflowSession links up to the AuditableWorkflow types. An Subject Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Subject Types link up to the ActiveRecord types (configuration changes).
+    
+    -Any workflow audit event created as of 10/11/2024 will be able to be queried by workflow name, workflow uid, or workflow profile type.
+    -Any profile audit event created as of 10/11/2024 will be able to be queried by profile type.
+    -The entity_type parameter has been updated to subject_type, which now matches what is in the response object.
+    -With the additional query filters added, there is a max of 5 filter parameters at one time (aside from pagination parameters)
+    
+    To accommodate these changes, an API contract change was required.  Please read the updated API documentation for the new request syntax.
   operationId: search
   tags:
     - audits

nerm/requestBodies/POST/AuditEvents.yaml

@@ -27,6 +27,6 @@ content:
               enum: [asc, desc]
               example: "asc"
             filters:
-              type: array
+              type: object
               items:
                 $ref: "../../schemas/POST/AuditEvent.yaml"

nerm/schemas/POST/AuditEvent.yaml

@@ -1,6 +1,6 @@
 type: object
 properties:
-  entity_type:
+  subject_type:
     description: Categorization of audit event.
     type: string
     enum: [Profile, WorkflowSession, Email, FormAttributeForm, FormAttribute, Form, IdproxyPermission, NeAttributeOption, NeAttribute, Notification, Page, Permission, PortalRegistrationWorkflow, Portal, ProfileTypeRole, ProfileType, RoleProfile, NeprofileRole, NeaccessRole, IdproxyRole, SecurityQuestion, UserManager, UserProfile, UserRole, User, Validation, VerificationEmail, WorkflowAction, CreateWorkflow, UpdateWorkflow, AutomatedWorkflow, BatchWorkflow, ExpirationWorkflow, InvitationWorkflow, LoginWorkflow, PasswordResetWorkflow, RegistrationWorkflow, Get, Post, Patch, Delete]
@@ -15,6 +15,29 @@ properties:
     type: string
     format: uuid
     example: 7d8c53ca-e99d-485c-9524-ea3849e82c79
-
-
-
+  data:
+    type: object
+    properties:
+      profile_id:
+        description: The profile id associated with the event
+        type: string
+        example: 7d8c53ca-e99d-485c-9524-ea3849e82c79
+        format: uuid
+      workflow_id:
+        description: The workflow id associated with the event
+        type: string
+        example: 7d8c53ca-e99d-485c-9524-ea3849e82c79
+        format: uuid
+      workflow_name:
+        description: The workflow name associated with the event
+        type: string
+        example: My Workflow
+      workflow_uid:
+        description: The workflow uid associated with the event
+        type: string
+        example: my_workflow
+      profile_type_id:
+        description: The profile type associated with the event
+        type: string
+        example: 7d8c53ca-e99d-485c-9524-ea3849e82c79
+        format: uuid