Audit Logs¶
-
class
py42.clients.auditlogs.
AuditLogsClient
(audit_log_service)¶ Bases:
object
-
get_all
(begin_time=None, end_time=None, event_types=None, user_ids=None, usernames=None, user_ip_addresses=None, affected_user_ids=None, affected_usernames=None, **kwargs)¶ Retrieve audit logs, filtered based on given arguments. Rest Documentation
Parameters: - begin_time (int or float or str or datetime, optional) – Timestamp in milliseconds or str format “yyyy-MM-dd HH:MM:SS” or a datetime instance. Defaults to None.
- end_time (int or float or str or datetime, optional) – Timestamp in milliseconds or str format “yyyy-MM-dd HH:MM:SS” or a datetime instance. Defaults to None.
- event_types (str or list, optional) – A str or list of str of valid event types. Defaults to None.
- user_ids (str or list, optional) – A str or list of str of Code42 userUids. Defaults to None.
- usernames (str or list, optional) – A str or list of str of Code42 usernames. Defaults to None.
- user_ip_addresses (str or list, optional) – A str or list of str of user ip addresses. Defaults to None.
- affected_user_ids (str or list, optional) – A str or list of str of affected Code42 userUids. Defaults to None.
- affected_usernames (str or list, optional) – A str or list of str of affected Code42 usernames. Defaults to None.
Returns: An object that iterates over
py42.response.Py42Response
objects that each contain a page of audit logs.Return type: generator
-
get_page
(page_num=1, page_size=None, begin_time=None, end_time=None, event_types=None, user_ids=None, usernames=None, user_ip_addresses=None, affected_user_ids=None, affected_usernames=None, **kwargs)¶ Retrieve a page of audit logs, filtered based on given arguments.
Note: page_num here can be used same way as other methods that have a page_num parameter in py42. However, under the hood, it subtracts one from the given page_num in the implementation as the Code42 Audit-Logs API expects the start page to be zero. Rest Documentation
Parameters: - page_num (int, optional) – The page number to get. Defaults to 1.
- page_size (int, optional) – The number of items per page. Defaults to py42.settings.items_per_page.
- begin_time (int or float or str or datetime, optional) – Timestamp in milliseconds or str format “yyyy-MM-dd HH:MM:SS” or a datetime instance. Defaults to None.
- end_time (int or float or str or datetime, optional) – Timestamp in milliseconds or str format “yyyy-MM-dd HH:MM:SS” or a datetime instance. Defaults to None.
- event_types (str or list, optional) – A str or list of str of valid event types. Defaults to None.
- user_ids (str or list, optional) – A str or list of str of Code42 userUids. Defaults to None.
- usernames (str or list, optional) – A str or list of str of Code42 usernames. Defaults to None.
- user_ip_addresses (str or list, optional) – A str or list of str of user ip addresses. Defaults to None.
- affected_user_ids (str or list, optional) – A str or list of str of affected Code42 userUids. Defaults to None.
- affected_usernames (str or list, optional) – A str or list of str of affected Code42 usernames. Defaults to None.
Returns:
-