Skip to content

Commit

Permalink
Automated commit 'Merge pull request #49 from sailpoint/NEROCKET-1747
Browse files Browse the repository at this point in the history
Nerocket-1747 revert of the revert of the revert of audit spec fix' by github action: 11295369527
  • Loading branch information
developer-relations-sp committed Oct 11, 2024
1 parent 715fd9f commit fbc1e9c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 38 deletions.
10 changes: 1 addition & 9 deletions nerm/paths/audit_events.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
post:
summary: Query for Audit events
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.
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).
operationId: search
tags:
- audits
Expand Down
4 changes: 2 additions & 2 deletions nerm/requestBodies/POST/AuditEvents.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ content:
enum: [asc, desc]
example: "asc"
filters:
type: object
properties:
type: array
items:
$ref: "../../schemas/POST/AuditEvent.yaml"
31 changes: 4 additions & 27 deletions nerm/schemas/POST/AuditEvent.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
type: object
properties:
subject_type:
entity_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]
Expand All @@ -15,29 +15,6 @@ 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



0 comments on commit fbc1e9c

Please sign in to comment.