Change Auditor 7.5 - User Guide

Connecting to Change Auditor

Connecting to Change Auditor

Most Change Auditor commands require a connection to a coordinator. You can make multiple connections to different coordinators or deployments in the same script as long as the version of Change Auditor is the same.

Example: Connect to the installation “XYZ” in the local forest

NOTE: This allows for fault tolerance if you have numerous coordinators by selecting the best option in the domain.

Connect-CAClient –InstallationName ‘XYZ’ -DomainName 'DomainName.com'

 

 

Managing subscriptions

Managing subscriptions

To begin sending event data, you need to create a subscription with Change Auditor. The subscription contains information about the URL to send the notifications and heartbeats and the event subsystems to include.

NOTE: You must be a member of the Change Auditor Administrators group to run these commands. NOTE: These are generic commands not tied to a specific SIEM tool.

•	New-CAEventWebhookSubscription

•	Get-CAEventWebhookSubscriptions

•	Set-CAEventWebhookSubscription

•	Remove-CAEventWebhookSubscription

•	Get-CAEventExportSubsystems

New-CAEventWebhookSubscription

New-CAEventWebhookSubscription

Use this command to create the subscription required to receive Change Auditor event data.

Table 2. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command. See the Change Auditor Command Guide for details.
-NotificationUrl	Specifies where to send notifications. The notification URL is provided by the webhook receiver.
-Subsystems	Specifies an array of event subsystems from which to send events. This can be single or multiple subsystems. NOTE: To obtain an array of subsystems, use the Get-CAEventExportSubsystems command and filter the list to specify the required subsystems.
-StartTimeUTC (Optional)	Specifies date and time from which events should be sent. The default is to start sending events from the time when the subscription is created. For example: • 20 July, 2020 12:01 PM uses local time • 2020-07-20 12:10:00Z uses UTC time The time will be local unless you specify the required flag to convert to UTC.
-BatchSize (Optional)	Specifies the maximum number of events to include in a single notification. The default is 10000 events.
-Enabled (Optional)	Specifies whether the subscription is enabled or disabled. By default it is enabled.
-HeartbeatUrl (Optional)	Specifies where (URL) to send heartbeat notifications. The URL is provided by the webhook receiver. NOTE: If no value is specified, heartbeat notifications are not sent.
-NotificationInterval (Optional)	Specifies how often (in milliseconds) notifications are sent to the receiver. By default, this is set to 0, resulting in a continuous stream of events.
-HeartbeatInterval (Optional)	Specifies how often (in milliseconds) heartbeat notifications are sent to webhook receiver. By default, this is set to every 5 minutes. Setting this to 0 disables the heartbeat notifications.
-AuthorizationId (Optional)	Specifies the unique identifier used to confirm that the specified subscriber is authorized to accept event data. The Id is provided by webhook receiver.
-AllowedCoordinators (Optional)	Specifies the DNS or NetBIOS name of the coordinators permitted to send events. By default, any coordinator can send the events. NOTE: The list order does not determine which coordinator is selected to send events.
-IncludeO365AADDetails (Optional)	Specifies whether to include the raw JSON event details provided by Microsoft. When set to true, the event will include a field named additionalDetails, containing the raw JSON string for Microsoft 365 and Microsoft Entra ID events. When set to false, the additionalDetails field is not included. By default, this is set to true.

Example: Create a subscription that sends Microsoft 365, Active Directory, and Exchange events captured since March 1 to www.quest.com

$startTimeUTC = Get-Date "March 1, 2020 12:00 PM"

$notificationUrl = "https://www.quest.com/api/webhook"

$selectedSubsystems = Get-CAEventExportSubsystems -Connection $connection | Where-Object DisplayName -In -Value "Microsoft 365", "Active Directory", "Exchange"

New-CAEventWebhookSubscription -Connection $connection -NotificationUrl $notificationUrl -StartTimeUTC $startTimeUTC -Subsystems $selectedSubsystems

Get-CAEventWebhookSubscriptions

Get-CAEventWebhookSubscriptions

Use this command to see the details of the current subscriptions.

Table 1. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command. See the Change Auditor Command Guide for details.
-SubscriptionId (optional)	The ID of an existing webhook subscription. If specified, the command will only return the webhook subscription with that ID. If not specified, all event subscriptions are returned, You can find the SubscriptionId by running this command using just the connection information. It is also returned by the New-CAEventWebhookSubscription command.

Example: List defined webhook subscriptions

Get-CAEventWebhookSubscriptions -Connection $connection

Command output

The command returns the following information.

Table 2. Available configuration information

Setting	Description
Id	The subscription ID.
StartTimeUTC	Starting point in time for events being sent.
Subsystems	Subsystems that contain the event data being sent.
Enabled	Whether the subscription is enabled.
NotificationInterval	How often how often (in milliseconds) notifications are sent.
HeartbeatInterval	How often (in milliseconds) heartbeat notifications are sent.
BatchSize	Batch size. (The maximum number of events that the active batch size can increase to.)
ActiveBatchSize	The current batch size. (The current number of events to include in a single notification message.) The batch size is automatically adjusted based on network throughput and system performance. Its value never exceeds the specified batch size.
NotificationUrl	URL for event notifications.
HeartbeatUrl	URL for heartbeat notifications.
LastEventTimeUTC	When the last event was sent.
LastEventResponse	The last event response. Provides the response in JSON format from the event receiver.
LastHeartbeatTimeUTC	When the last heartbeat was sent.
LastHeartbeatResponse	Last heartbeat response. (For example OK, HTTP 429 - Too many events being sent., and HTTP 401 - Unauthorized access.)
EventsSent	Number of events sent.
BatchesSent	Number of batches sent.
HeartbeatsSent	Number of heartbeats sent.
BookmarkTime	Time of the event that was last sent.
AllowedCoordinators	List of coordinators permitted to send events.
LastCoordinator	The coordinator that is sending events. If the subscription is disabled, this is the last coordinator that sent events.
Internal	Whether this is an internal webhook created for a particular subscription.