client-api-audit-log-rest-resource

Get all user audit log events for your organization in the time frame, limited to 500 records

post/api/v1/audit-log/user-events

Request

Request body

startstring date-time required

Start date for the audit log query

endstring date-time required

End date for the audit log query

eventTypesstring[]

Set of specific event types to retrieve. If null or empty, returns all event types. Allowed values (by category): USER_: USER_LOGGED_IN, USER_LOGGED_OUT, EXISTING_USER_FIRST_LOG_IN, NEW_USER_FIRST_LOG_IN, USER_UPLOADED_ARTIFACT, USER_DOWNLOADED_ARTIFACT, USER_EXPORTED_ARTIFACT, USER_CREATED, USER_UPDATED, USER_SUBSCRIBED, USER_UNSUBSCRIBED, USER_DEFAULT_SUBSCRIBER_ADDED, USER_DEFAULT_SUBSCRIBER_REMOVED ORG_: ORG_CREATED, ORG_UPDATED, ORG_FIRST_LOGIN, ORG_OFFBOARD_IN_PROGRESS, ORG_OFFBOARD_SUCCESS, ORG_OFFBOARD_FAILED, ORG_SUBDOMAIN_SET, ORG_ASSESSMENT_DEFAULTS_CREATED, ORG_ASSESSMENT_DEFAULTS_UPDATED ASSESSMENT_: ASSESSMENT_CREATED, ASSESSMENT_UPDATED, ASSESSMENT_COMPLETED, ASSESSMENT_CANCELLED, ASSESSMENT_CANCELLED_BY_VENDOR, ASSESSMENT_CANCELLED_BY_CLIENT, ASSESSMENT_CANCELLED_BY_AUDITOR, ASSESSMENT_CANCELLED_BY_ADMIN, ASSESSMENT_AUTOMATICALLY_CANCELLED, ASSESSMENT_EXPIRED, ASSESSMENT_AUDIT_COMPLETED, ASSESSMENT_STATUS_CHANGED RELATIONSHIP_: RELATIONSHIP_CREATED, RELATIONSHIP_ARCHIVED, RELATIONSHIP_ONBOARDED, RELATIONSHIP_UPDATED, RISK_ACCEPTED, RISK_ACCEPTANCE_REVOKED, PRIMARY_CONTACT_CHANGED

Response

OK

auditEventType'USER_LOGGED_OUT' | 'USER_CREATED' | 'USER_UPDATED' | 'USER_FIRST_LOG_IN' | 'EXISTING_USER_FIRST_LOG_IN' | 'NEW_USER_FIRST_LOG_IN' | 'USER_LOGGED_IN' | 'USER_DEFAULT_SUBSCRIBER_ADDED' | 'USER_DEFAULT_SUBSCRIBER_REMOVED' | 'USER_SUBSCRIBED' | 'USER_UNSUBSCRIBED' | 'USER_UPLOADED_ARTIFACT' | 'USER_DOWNLOADED_ARTIFACT' | 'USER_EXPORTED_ARTIFACT'
dateTimestring date-time
emailstring
userIdinteger

Changes

No recorded changes to this operation across all 1 revision of this API.