Skip to main content

Query for Audit events

POST 
/audit_events/query

This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. A 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.

Request​

Body

required

    audit_events

    object

    offset int32

    The page of pagination for these events.

    sort_by string

    A column that we are sorting these records from.

    limit int32

    The limiting count for the amount of records returned.

    order string

    Possible values: [asc, desc]

    Which direction the list should be sorted by

    filters

    object

    subject_type string

    Possible values: [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]

    Categorization of audit event.

    type string

    Possible values: [AuditableProfileCreate, AuditableProfileUpdate, AuditableProfileDestroy, AuditableBulkProfileUpdate, AuditableProfileContributorAdd, AuditableProfileContributorRemove, AuditableProfileContributorRoleAdd, AuditableProfileContributorRoleRemove, AuditableProfileOwnerUpdate, AuditableProfileWorkflowEvent, AuditableWorkflowActionSkippedEvent, AuditableWorkflowApprovedEvent, AuditableWorkflowApprovedEvent, AuditableWorkflowAssignedEvent, AuditableWorkflowAutoAssignedEvent, AuditableWorkflowBatchCompleteEvent, AuditableWorkflowClosedEvent, AuditableWorkflowDuplicateCheckStartEvent, AuditableWorkflowDuplicateResolutionEvent, AuditableWorkflowFailedEvent, AuditableWorkflowIdentityProofedEvent, AuditableWorkflowInvitationSentEvent, AuditableWorkflowLdapProvidedEvent, AuditableWorkflowNotificationSentEvent, AuditableWorkflowPendingApprovalEvent, AuditableWorkflowPendingAssignmentEvent, AuditableWorkflowPendingFulfillmentEvent, AuditableWorkflowFulfilledEvent, AuditableWorkflowPendingIdentityProofEvent, AuditableWorkflowPendingLdapEvent, AuditableWorkflowPendingRequestEvent, AuditableWorkflowPendingReviewEvent, AuditableWorkflowProfileCreatedEvent, AuditableWorkflowProfileSelectEvent, AuditableWorkflowProfileUpdatedEvent, AuditableWorkflowRejectedEvent, AuditableWorkflowRequestMadeEvent, AuditableWorkflowRestApiEvent, AuditableWorkflowReviewedEvent, AuditableWorkflowRunningWorkflowEvent, AuditableWorkflowSoapApiEvent, AuditableWorkflowStatusChangedEvent, AuditableWorkflowStoredProcedureEvent, AuditableWorkflowUnassignEvent, AuditableWorkflowWaitingForWorkflowEvent, AuditableWorkflowWorkflowChangedEvent, ActiveRecordCreate, ActiveRecordUpdate, ActiveRecordDestroy, AuditableApiEvent]

    The type of audit event

    subject_id uuid

    Identifier of the subject

    data

    object

    profile_id uuid

    The profile id associated with the event

    workflow_id uuid

    The workflow id associated with the event

    workflow_name string

    The workflow name associated with the event

    workflow_uid string

    The workflow uid associated with the event

    profile_type_id uuid

    The profile type associated with the event

Responses​

AuditEvents

Schema

    audit_events

    object[]

  • Array [

    • subject_type string

    Possible values: [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]

    Categorization of audit event.

    type string

    Possible values: [AuditableProfileCreate, AuditableProfileUpdate, AuditableProfileDestroy, AuditableBulkProfileUpdate, AuditableProfileContributorAdd, AuditableProfileContributorRemove, AuditableProfileContributorRoleAdd, AuditableProfileContributorRoleRemove, AuditableProfileOwnerUpdate, AuditableProfileWorkflowEvent, AuditableWorkflowActionSkippedEvent, AuditableWorkflowApprovedEvent, AuditableWorkflowApprovedEvent, AuditableWorkflowAssignedEvent, AuditableWorkflowAutoAssignedEvent, AuditableWorkflowBatchCompleteEvent, AuditableWorkflowClosedEvent, AuditableWorkflowDuplicateCheckStartEvent, AuditableWorkflowDuplicateResolutionEvent, AuditableWorkflowFailedEvent, AuditableWorkflowIdentityProofedEvent, AuditableWorkflowInvitationSentEvent, AuditableWorkflowLdapProvidedEvent, AuditableWorkflowNotificationSentEvent, AuditableWorkflowPendingApprovalEvent, AuditableWorkflowPendingAssignmentEvent, AuditableWorkflowPendingFulfillmentEvent, AuditableWorkflowFulfilledEvent, AuditableWorkflowPendingIdentityProofEvent, AuditableWorkflowPendingLdapEvent, AuditableWorkflowPendingRequestEvent, AuditableWorkflowPendingReviewEvent, AuditableWorkflowProfileCreatedEvent, AuditableWorkflowProfileSelectEvent, AuditableWorkflowProfileUpdatedEvent, AuditableWorkflowRejectedEvent, AuditableWorkflowRequestMadeEvent, AuditableWorkflowRestApiEvent, AuditableWorkflowReviewedEvent, AuditableWorkflowRunningWorkflowEvent, AuditableWorkflowSoapApiEvent, AuditableWorkflowStatusChangedEvent, AuditableWorkflowStoredProcedureEvent, AuditableWorkflowUnassignEvent, AuditableWorkflowWaitingForWorkflowEvent, AuditableWorkflowWorkflowChangedEvent, ActiveRecordCreate, ActiveRecordUpdate, ActiveRecordDestroy, AuditableApiEvent]

    The type of audit event

    subject_id uuid

    Identifier of the subject

    data

    object

    profile_id uuid

    The profile id associated with the event

    workflow_id uuid

    The workflow id associated with the event

    workflow_name string

    The workflow name associated with the event

    workflow_uid string

    The workflow uid associated with the event

    profile_type_id uuid

    The profile type associated with the event

  • ]

Loading...