Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/threatmanager/3.1/administration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "Administration",
"position": 40,
"collapsed": true,
"collapsible": true,
"link": {
"type": "doc",
"id": "overview"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "Configuration Menu",
"position": 20,
"collapsed": true,
"collapsible": true,
"link": {
"type": "doc",
"id": "overview"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "Integrations Interface",
"position": 30,
"collapsed": true,
"collapsible": true,
"link": {
"type": "doc",
"id": "overview"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
---
title: "Active Directory Sync Page"
description: "Active Directory Sync Page"
sidebar_position: 10
---

# Active Directory Sync Page

The Active Directory Sync page within the Integrations interface lists the domains that are synced
to the Threat Manager database. The sync operation gets all information about an Active Directory
environment (users, groups, hosts, etc). See the
[Permissions for Active Directory Sync ](/docs/threatmanager/3.1/requirements/permissions/adsync.md) topic for
additional information about the permissions required for Active Directory syncing.

Use the gear icon in the upper right corner of the console to open the Configuration menu. Then
select **Integrations** to open the Integrations interface.

Click **Active Directory Sync** in the navigation pane to view a list of the already added Active
Directory domains, if any. Each added domain represents a sync policy.

![Integrations interface on the Active Directory Sync page](/images/threatmanager/3.0/administration/configuration/integrations/page.webp)

A service named Active Directory Service continuously runs to collect data for the specified
domain(s). It evaluates the USN value of an object and syncs when the object changes. The table
provides the following information:

- Name – Name of the domain. This may be either the domain DNS name or domain controller hostname.
- Enabled – icon indicates the enabled state:

- Checkmark icon – Enabled
- X icon – Disabled

- Profile – Name of the Credential Profile assigned to the policy. As mentioned earlier, each added
domain represents a sync policy.
- Last Sync Start – Date timestamp when the task started for the most recent sync
- Last Sync Status – Event status for the most recent sync task

To view policy details or make modifications, select a domain from the table or under Active
Directory Sync in the navigation pane.

## Add an Active Directory Sync Policy

:::note
Prior to adding an Active Directory Sync policy, you must first configure a Credential
Profile with credentials properly provisioned for running the sync operation for the domain. See the
[Application Server Requirements](/docs/threatmanager/3.1/requirements/server.md) topic for the permissions. See
the [Credential Profile Page](/docs/threatmanager/3.1/administration/configuration/integrations/credentialprofile.md) topic for additional information on creating a
profile.
:::


Follow the steps to add a domain/Active Directory sync policy.

**Step 1 –** Use the gear icon in the upper right corner of the console to open the Configuration
menu. Then select **Integrations** to open the Integrations interface.

**Step 2 –** On the Integrations interface, click Add New Integration in the navigation pane. The
Add New Integration window opens.

![Add New Integration window with Active Directory Sync type selected](/images/threatprevention/7.5/reportingmodule/configuration/integrations/activedirectorysync.webp)

**Step 3 –** In the Type drop-down menu, select Active Directory Sync.

**Step 4 –** Enter the following information:

- Domain – Enter the domain DNS name or domain controller hostname in the required format of
[DOMAIN.COM], e.g. NT-DC03.NWXTech.com
- Credential Profile – Select the Credential Profile by name from the drop-down menu. This was
pre-created in the Credential Profiles page.
- Enabled / Disabled – Toggle indicates if the policy is enabled to run the sync service. By default
it is set to Enabled.
- Max Renew Ticket Age (days) – The value indicates the maximum number of days of the Renew Ticket
Age for the domain. This value must match the domain configuration. See the Microsoft
[Max-Renew-Age attribute](https://docs.microsoft.com/en-us/windows/win32/adschema/a-maxrenewage)
article for additional information. The default value is 7 days; modify the value by typing in the
textbox.
- Max Ticket Age (hours) – The value indicates the maximum number of hours of the Ticket Age for the
domain. This value must match the domain configuration. See the Microsoft
[Max-Ticket-Age attribute](https://docs.microsoft.com/en-us/windows/win32/adschema/a-maxticketage)
article for additional information. The default value is 10 hours; modify the value by typing in
the textbox.
- Use SSL – Check the box to enable SSL for secure communication with the domain. See the Microsoft
[5.1.1.2 Using SSL/TLS](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-adts/8e73932f-70cf-46d6-88b1-8d9f86235e81#5112-using-ssltls)
article for additional information.

**Step 5 –** Click **Test Connection** to ensure connection to the domain. This will take a moment.
Then a message will appear in the upper right corner of the console indicating a successful or
failed connection.If successful, move on to the next step. If failed, recheck your entries for error
and repeat this step until a successful connection is established.

**Step 6 –** Click Add. The Add New Integration window closes.

The domain or domain controller (the Domain value supplied in Step 4) is listed in the Integrations
navigation pane. Repeat the process to add additional domains.

## Active Directory Sync Policy Details

Follow the steps to view the details of an Active Directory sync policy.

**Step 7 –** Use the gear icon in the upper right corner of the console to open the Configuration
menu. Then select **Integrations** to open the Integrations interface.

**Step 8 –** On the Integrations interface, click **Active Directory Sync** in the navigation pane
to view a list of the already created Active Directory Sync policies, if any. A policy is
represented by the domain for which it is created.

**Step 9 –** Select a domain from the table or the navigation pane to view the details of the Active
Directory Sync policy created for that domain.

![Active Directory Sync details page for a specific domain](/images/threatmanager/3.0/administration/configuration/integrations/details.webp)

Select the domain from the list to see modification options:

- Name – The box at the top displays the name of the domain

- Delete – The delete button in the upper right corner of the box opens the Delete Domain window
to confirm the action

- Domain Configuration – Displays the sync policy settings entered for the selected domain. These
settings can be modified on this tab. See the Domain Configuration Tab topic for additional
information.
- Sync History – Displays the information on each synchronization event. See the Sync History Tab
topic for additional information.

### Domain Configuration Tab

The Domain Configuration tab displays the sync policy settings entered for the selected domain. With
the exception of the domain itself, these settings can be updated as needed.

![Active Directory Sync details page for a specific domain showing the Domain Configuration tab](/images/threatmanager/3.0/administration/configuration/integrations/domainconfigurationtab.webp)

The Domain Configuration tab displays the following settings:

- Domain – Displays the domain DNS name or domain controller hostname in the required format of
[DOMAIN.COM], e.g. NT-DC03.NWXTech.com
- Credential Profile – Displays the Credential Profile by name
- Enabled / Disabled – Toggle indicates if the policy is enabled to run the sync service
- Max Renew Ticket Age (days) – Displays the value indicates the maximum number of days of the Renew
Ticket Age for the domain. This value must match the domain configuration. See the Microsoft
[Max-Renew-Age attribute](https://docs.microsoft.com/en-us/windows/win32/adschema/a-maxrenewage)
article for additional information.

:::note
This value is required to accurately evaluate the Golden Ticket threat.
:::


- Max Ticket Age (hours) – Displays the value indicates the maximum number of hours of the Ticket
Age for the domain. This value must match the domain configuration. See the Microsoft
[Max-Ticket-Age attribute](https://docs.microsoft.com/en-us/windows/win32/adschema/a-maxticketage)
article for additional information.

:::note
This value is required to accurately evaluate the Golden Ticket threat.
:::


- Use SSL – Indicates whether you have enabled SSL for secure communication with the domain. See the
Microsoft
[5.1.1.2 Using SSL/TLS](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-adts/8e73932f-70cf-46d6-88b1-8d9f86235e81#5112-using-ssltls)
article for additional information.
- Perform a full scan on next run – Indicates whether the next sync will only look for domain
changes or run a full scan of the domain. By default, this option is enabled for the first sync
executed when a new domain is added; however, it is disabled automatically after the first sync.
This can be used to fully refresh domain information, but is typically not needed for normal
operation.
- Test Connection – Click **Test Connection** to ensure connection to the domain. This will take a
moment. Then a message will appear in the upper right corner of the console indicating a
successful or failed connection.

The Save button is enabled when any settings are modified. Click it to commit the changes before
leaving the page.

### Sync History Tab

The Sync History tab displays the information on each synchronization event. This includes general
information about user, group, and computer objects within the selected domain.

![Active Directory Sync details page for a specific domain showing the Sync History tab](/images/threatmanager/3.0/administration/configuration/integrations/synchistorytab.webp)

The table provides the following information:

- Start Time – Date timestamp when the task started
- End Time – Date timestamp when the task completed
- Users – Number of user objects in the domain
- Users Changed – Number of user objects with changes detected since the last sync
- Groups – Number of group objects in the domain
- Groups Changed – Number of group objects with changes detected since the last sync
- Computers – Number of computer objects in the domain
- Computers Changed – Number of computer objects with changes detected since the last sync
- Status – Event status for the sync task

The table is designed to display 10 records at a time, by default. However, you can set this to 50,
100, or 1,000 rows with the drop-down menu above the right corner of the table. There is a search
box above the left corner of the table. Page navigation buttons are below the table. You can also
export the data from the current page using the **Export CSV** button.

## Modify Active Directory Sync Policy

Follow the steps to modify the Active Directory Sync policy for the selected Active Directory
domain.

**Step 1 –** On the Integrations interface, click **Active Directory Sync** in the navigation pane
to view a list of the already created Active Directory Sync policies, if any. A policy is
represented by the domain for which it is created.

**Step 2 –** The Domain Configuration tab opens, where you can make the desired modification.

:::tip
Remember, the domain cannot be modified.
:::


![Active Directory Sync details page for a specific domain showing the Domain Configuration tab](/images/threatmanager/3.0/administration/configuration/integrations/domainconfigurationtab.webp)

**Step 3 –** To modify the Credential Profile, select the Credential Profile by name from the
drop-down menu. This was pre-created in the Credential Profiles page.

:::note
If you modify the Credential Profile for a domain, click **Test Connection** to ensure
connection to the domain. This will take a moment. Then a message will appear in the upper right
corner of the console indicating a successful or failed connection.
:::


**Step 4 –** Click the toggle to change the Enabled/Disabled state of the policy.

**Step 5 –** For the Max Renew Ticket Age (days) value, modify the value by typing in the textbox.

**Step 6 –** For the Max Ticket Age (hours) value, modify the value by typing in the textbox.

**Step 7 –** Select or deselect the **Use SSL** box for the desired security state for communication
with the domain.

**Step 8 –** Select the **Perform a full scan on next run** checkbox to force the next sync to run a
full scan of the domain.

**Step 9 –** The Save button is enabled when any settings are modified. Click it to commit the
changes before leaving the page.

The changes to the Domain Configuration have been saved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: "App Tokens Page"
description: "App Tokens Page"
sidebar_position: 30
---

# App Tokens Page

The App Tokens page provides the ability to generate and manage the app tokens needed to send data
to Threat Manager. An app token is used by Threat Manager and/or the Activity Monitor to push Active
Directory activity data into the Threat Manager database. An app token is used by Access Analyzer to
push a list of files containing sensitive data into the Threat Manager database.

![page](/images/threatmanager/3.0/administration/configuration/integrations/page_1.webp)

It is necessary to generate an app token for each product integration. The App Tokens table displays
the following information for each generated app token:

- Name – Name of the app token
- Description – Description for the app token
- Enabled – If set to ON, allows access to the generated app token. If set to OFF, disallows access
for the generated app token.

## Generate an App Token

Follow the steps to generate an app token.

**Step 1 –** On the Integrations page, click **Add New Integration**.

![apptoken](/images/threatmanager/3.0/administration/configuration/integrations/apptoken.webp)

**Step 2 –** In the Type drop-down menu, select **App Token**.

**Step 3 –** Enter a Name for the token in the Name field, and a Description for the token in the
Description field.

:::info
Identify the data source for this app in either the Name or Description fields.
:::


**Step 4 –** Click Add to generate the app token.

The app token is added to the App Tokens list in the Integrations box.

## View and Copy the App Token

To view the details for an app token, click on the app token name in the Integrations box. The top
of the page displays the app token name and the description. These can be modified by clicking on
the name or description and entering the desired information.

![details](/images/threatmanager/3.0/administration/configuration/integrations/details_1.webp)

Ensure that the app token is enabled for sending data to Threat Manager. In the General box, verify
that the status is set to **ON**.

Follow the instructions to copy the app token.

**Step 1 –** In the App Token box, click **Copy Token**.The app token is copied to the clipboard.

**Step 2 –** Paste the app token to the desired location.

**Step 3 –** Click **Save** to save any changes to the page.

Repeat this process to copy any desired app tokens.
Loading