wxc_sdk.admin_audit package

class wxc_sdk.admin_audit.AdminAuditEventsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Admin Audit Events

Admin Audit Events are available to full administrators for certain events performed in Webex Control Hub.

Administrators with accounts created before 2019 who have never logged into Webex Control Hub will need to log into Webex Control Hub at least once to enable access to this API.

An administrator account with the audit:events_read scope is required to use this API.

list_events(org_id: str, from_: str | datetime, to_: str | datetime, actor_id: str | None = None, event_categories: list[str] | None = None, **params) → Generator[AuditEvent, None, None][source]

List Admin Audit Events

List admin audit events in your organization. Several query parameters are available to filter the response.

Long result sets will be split into pages.

NOTE: A maximum of one year of audit events can be returned per request.

Parameters:

org_id (str) – List events in this organization, by ID.
from (Union[str, datetime]) – List events which occurred after a specific date and time.
to (Union[str, datetime]) – List events which occurred before a specific date and time.
actor_id (str) – List events performed by this person, by ID.
event_categories (list[str]) – List events, by event categories.

Returns:

Generator yielding AuditEvent instances

list_event_categories() → list[str][source]

List Admin Audit Event Categories

Get the list of all admin event categories.

Return type:: list[str]

base = 'adminAudit'

Bases: ApiModel

data: AuditEventData | None

created: datetime | None: The date and time the event took place.

actor_org_id: str | None: The orgId of the person who made the change.

id: str | None: A unique identifier for the event.

actor_id: str | None: The personId of the person who made the change.

Bases: ApiModel

class Config[source]

Bases: object

extra = 'allow'

actor_org_name: str | None: The display name of the organization.

target_name: str | None: The name of the resource being acted upon.

event_description: str | None: A description for the event.

actor_name: str | None: The name of the person who performed the action.

actor_email: str | None: The email of the person who performed the action.

admin_roles: list[str] | None: Admin roles for the person.

tracking_id: str | None: A tracking identifier for the event.

target_type: str | None: The type of resource changed by the event.

target_id: str | None: The identifier for the resource changed by the event.

event_category: str | None: The category of resource changed by the event.

actor_user_agent: str | None

actor_ip: str | None: The IP address of the person who performed the action.

target_org_id: str | None: The orgId of the organization.

action_text: str | None: A more detailed description of the change made by the person.

target_org_name: str | None: The name of the organization being acted upon.

account_name: Any | None

action_client_id: Any | None

action_client_name: Any | None

action: Any | None

activated_numbers: Any | None

actor_client_id: Any | None

actor_client_name: Any | None

added_pattern: Any | None

attributes: Any | None

authorized_status: Any | None

api_version: Any | None

business_text_status: Any | None

capacity: Any | None

change_detail_id: Any | None

change_set: Any | None

changed_attributes: Any | None

changed_group_members: Any | None

client_id: Any | None

client_type: Any | None

command_key: Any | None

config_key: Any | None

config_value: Any | None

contact_info: Any | None

contact_type: Any | None

current_location_name: Any | None

dect_network_name: Any | None

deleted_auth_code: Any | None

deleted_pattern_name: Any | None

deleted_pattern: Any | None

deleted_settings: Any | None

details: Any | None

device_id: Any | None

domain_name: Any | None

domain_state: Any | None

email_address_count: Any | None

email_type: Any | None

end_date: Any | None

enrollment_status: Any | None

entitlements: Any | None

entity_id: Any | None

entity_type: Any | None

event_status: Any | None

extension_time: Any | None

external_admin_email: Any | None

external_admin_org_name: Any | None

failed_reason: Any | None

feature_type: Any | None

file_name: Any | None

group_name: Any | None

is_manual_switchback_enabled: Any | None

job_name: Any | None

locale: Any | None

location_id: Any | None

location_name: Any | None

location: Any | None

mac_address: Any | None

name: Any | None

new_org_default_enabled: Any | None

new_vendor_name: Any | None

numbers_updated: Any | None

numbers: Any | None

offer_map: Any | None

old_org_default_enabled: Any | None

old_vendor_name: Any | None

operating_mode_level: Any | None

operating_mode_name: Any | None

operation_type: Any | None

operation: Any | None

org_id: Any | None

owner_id: Any | None

owner_type: Any | None

portability_numbers: Any | None

previous_value: Any | None

report_id: Any | None

reserved_numbers: Any | None

result: Any | None

role_added: Any | None

role_removed: Any | None

rule_name: Any | None

service_app_scopes: Any | None

services: Any | None

setting_key: Any | None

setting_name: Any | None

setting_value: Any | None

site_admin_roles: Any | None

start_date: Any | None

tags: Any | None

target_email: Any | None

target_location_name: Any | None

template_name: Any | None

template_type: Any | None

token_id: Any | None

trial_expiration_dtm: Any | None

trial_id: Any | None

trial_period_days: Any | None

trial_start_dtm: Any | None

type: Any | None

updated_fields: Any | None

updated_settings: Any | None

user_name: Any | None

user_roles: Any | None

vendor_name: Any | None