CBAPI-5258: Implement audit log search API #500
Conversation
src/cbc_sdk/platform/audit.py
Outdated
| @staticmethod | ||
| def _create_valid_time_filter(kwargs): | ||
| """ | ||
| Verifies that an alert criteria key has the timerange functionality |
There was a problem hiding this comment.
Yeah, that's why this was still only a draft PR, because I wanted one more chance to go over all the docstrings. :)
src/cbc_sdk/platform/__init__.py
Outdated
| from cbc_sdk.platform.audit import AuditLog | ||
| from cbc_sdk.platform.audit import AuditLogRecord | ||
|
|
||
| from cbc_sdk.platform.audit import AuditLogRecord as AuditLog |
There was a problem hiding this comment.
Why do we need to rename this?
There was a problem hiding this comment.
Because the name of the class is misleading; it was AuditLog but it really represents a single record in the audit log, hence, AuditLogRecord. The old name must be kept around, however, for backward compatibility.
There was a problem hiding this comment.
AuditLog is both plural and singular. It is an Audit Log
There was a problem hiding this comment.
So, you're saying that the class shouldn't be renamed?
There was a problem hiding this comment.
Yes I am suggesting we don't rename the class unless we have a functional reason why we need a different name
| @@ -39,3 +67,275 @@ def get_auditlogs(cb): | |||
| """ | |||
| res = cb.get_object("/integrationServices/v3/auditlogs") | |||
There was a problem hiding this comment.
Is there a plan to replace this with _queue?
There was a problem hiding this comment.
Yes, that would be story CBAPI-5259.
Pull request checklist
Please check if your PR fulfills the following requirements:
What is the ticket or issue number?
https://jira.carbonblack.local/browse/CBAPI-5258
Pull Request Description
Implemented audit log search by using a query object in the standard pattern. Query object supports standard criteria and exclusions and async queries.
Does this introduce a breaking change?
How Has This Been Tested?
Unit tests have been written; test coverage at 97%.