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. example: 2019-01-02T16:58:36.845Z

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

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

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

Bases: ApiModel

class Config[source]

Bases: object

extra = 'allow'

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

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

event_description: str | None: A description for the event. example: An Admin logged in

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

actor_email: str | None: The email of the person who performed the action. example: joe@example.com

admin_roles: list[str] | None: Admin roles for the person. example: [‘User’, ‘Full_Admin’, ‘id_full_admin’]

tracking_id: str | None: A tracking identifier for the event. example: ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0

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

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

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

actor_user_agent: str | None

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

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

action_text: str | None: A more detailed description of the change made by the person. example: Joe Smith logged into organization Acme Inc.

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

action_client_id: Any | None

action_client_name: Any | None

actor_client_id: Any | None

actor_client_name: Any | None

added_pattern: Any | None

attributes: Any | None

authorized_status: Any | None

capacity: Any | None

change_detail_id: Any | None

changed_attributes: Any | None

changed_group_members: Any | None

client_id: Any | None

config_key: Any | None

config_value: Any | None

deleted_auth_code: Any | None

deleted_pattern_name: Any | None

dect_network_name: Any | None

email_type: Any | None

enrollment_status: Any | None

entitlements: Any | None

entity_type: Any | None

event_status: Any | None

external_admin_email: Any | None

external_admin_org_name: Any | None

failed_reason: Any | None

job_name: Any | None

locale: Any | None

location: Any | None

location_id: Any | None

location_name: Any | None

mac_address: Any | None

name: Any | None

numbers: Any | None

offer_map: Any | None

operation: Any | None

operation_type: Any | None

org_id: Any | None

owner_id: Any | None

owner_type: Any | None

previous_value: 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

tags: Any | None

target_email: 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