TeamDynamix
TeamDynamix is an IT Service Management (ITSM) tool. You can bring asset, configuration item, group, location, people, and ticket data from TeamDynamix into Brinqa to gain a unified view of your attack surface, thus strengthening your cybersecurity posture.
This document details the information you must provide for the connector to authenticate with TeamDynamix and how to obtain that information from TeamDynamix. See create a data integration for step-by-step instructions on setting up the integration.
Required connection settings
When setting up a data integration, select TeamDynamix from the Connector drop-down. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate TeamDynamix with Brinqa:
-
API URL: The TeamDynamix API URL. The default URL format is:
https://tdx.<domain>.com
. -
Username and Password: The username and password associated with the TeamDynamix account, which must have permissions to log in to the API server and return data.
Additional settings
The TeamDynamix connector contains additional options for configuration:
-
Application ID: The TeamDynamix ticketing application ID.
The TeamDynamix application ID is used to scope ticket retrieval to a specific application (e.g., the ticketing app). If provided, the connector uses this ID when making API requests. This setting can be useful when your TeamDynamix environment contains multiple applications and you want to target a specific one. For additional information, see TeamDynamix documentation.
noteThe Ticket object is not retrieved or mapped by default. If you configure this setting and wish to retrieve tickets from your TeamDynamix environment, you must create your own mapping. For additional information, please contact your Brinqa support team and see the following resources:
-
Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.
-
Parallel requests: The maximum number of parallel API requests. The default setting is 4.
-
Maximum retries: The maximum number of times that the integration attempts to connect to the TeamDynamix API before giving up and reporting a failure. The default setting is 5.
Types of data to retrieve
The TeamDynamix connector can retrieve the following types of data from the TeamDynamix API:
Table 1: Data retrieved from TeamDynamix
Connector Object | Required | Maps to Data Model |
---|---|---|
Asset | Yes | Asset |
Configuration Item | No | Not mapped |
Group | Yes | Team |
Location | No | Not mapped |
People | Yes | Person |
Ticket | No | Not mapped |
For detailed steps on how to view the data retrieved from TeamDynamix in the Brinqa Platform, see How to view your data.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes.
Asset
Table 2: Asset attribute mappings
Source Field Name | Maps to Attribute |
---|---|
AcquisitionDate | Local variable |
AppID | Local variable |
AppName | Local variable |
AssetID | uid |
Category | categories |
ConfigurationItemID | Local variable |
CreatedDate | sourceCreatedDate |
CreatedFullName | Local variable |
CreatedUid | Local variable |
ExternalID | Local variable |
ExternalSourceID | Local variable |
ExternalSourceName | Local variable |
ExpectedReplacementDate | Local variable |
FormID | Local variable |
FormName | Local variable |
ID | uid |
LocationID | Local variable |
LocationName | Local variable |
LocationRoomID | Local variable |
LocationRoomName | Local variable |
MaintenanceScheduleID | Local variable |
MaintenanceScheduleName | Local variable |
ManufacturerID | Local variable |
ManufacturerName | Local variable |
ModifiedDate | sourceLastModified |
ModifiedFullName | Local variable |
ModifiedUid | Local variable |
Name | name |
OwningCustomerID | Local variable |
OwningCustomerName | Local variable |
OwningDepartmentID | Local variable |
OwningDepartmentName | Local variable |
ParentID | Local variable |
ParentName | Local variable |
ParentSerialNumber | Local variable |
ParentTag | Local variable |
ProductModelID | Local variable |
ProductModelName | Local variable |
PurchaseCost | Local variable |
RequestingCustomerID | Local variable |
RequestingCustomerName | Local variable |
RequestingDepartmentID | Local variable |
RequestingDepartmentName | Local variable |
SerialNumber | Local variable |
StatusID | Local variable |
StatusName | status |
SupplierID | Local variable |
SupplierName | Local variable |
Tag | tags |
Uri | Local variable |
Group
Table 3: Group attribute mappings
Source Field Name | Maps to Attribute |
---|---|
CreatedDate | sourceCreatedDate |
Description | description |
ExternalID | Local variable |
ID | uid |
IsActive | status |
ModifiedDate | sourceLastModified |
Name | name |
People
Table 4: People attribute mappings
Source Field Name | Maps to Attribute |
---|---|
AboutMe | Local variable |
AlternateEmail | emails |
AlternateID | Local variable |
ApplyTechnicianSignatureToReplies | Local variable |
ApplyTechnicianSignatureToUpdatesAndComments | Local variable |
AuthenticationProviderID | Local variable |
AuthenticationUserName | Local variable |
BEID | Local variable |
BEIDInt | Local variable |
Company | Local variable |
CostRate | Local variable |
CreatedDate | sourceCreatedDate |
DefaultAccountID | Local variable |
DefaultAccountName | department |
DefaultPriorityID | Local variable |
DefaultPriorityName | Local variable |
DefaultRate | Local variable |
Description | description |
DisplayName | Local variable |
emails | |
EndDate | Local variable |
ExternalID | Local variable |
Fax | Local variable |
FirstName | firstName |
FullName | name |
HomeAddress | Local variable |
HomeCity | Local variable |
HomeCountry | Local variable |
HomePhone | homePhone |
HomeState | Local variable |
HomeZip | Local variable |
ID | uid |
IMHandle | Local variable |
IMProvider | Local variable |
IsActive | status |
IsCapacityManaged | Local variable |
IsConfidential | Local variable |
IsEmployee | Local variable |
JobTitle | jobTitle |
LastName | lastName |
LocationID | Local variable |
LocationName | Local variable |
LocationRoomID | Local variable |
LocationRoomName | Local variable |
MiddleName | Local variable |
MobilePhone | mobilePhone |
ModifiedDate | sourceLastModified |
Name | name |
Nickname | Local variable |
OtherPhone | otherPhone |
Pager | Local variable |
PrimaryClientPortalApplicationID | Local variable |
PrimaryEmail | emails |
PrimaryPhone | primaryPhone |
ProfileImageFileName | Local variable |
ReferenceID | Local variable |
ReportTimeAfterDate | Local variable |
ReportsToFullName | reportsTo |
ReportsToUID | Local variable |
ResourcePoolID | Local variable |
ResourcePoolName | Local variable |
Salutation | Local variable |
SecurityRoleID | Local variable |
SecurityRoleName | Local variable |
ShouldReportTime | Local variable |
TechnicianSignature | Local variable |
Title | jobTitle |
TZID | Local variable |
TZName | Local variable |
TypeID | Local variable |
UID | uid |
UserName | userName |
WorkAddress | Local variable |
WorkCity | Local variable |
WorkCountry | Local variable |
WorkPhone | workPhone |
WorkState | Local variable |
WorkZip | Local variable |
WorkableHours | Local variable |
Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.
Operation options
The Team Dynamix connector supports the following operation options. See connector operation options for information about how to apply them.
Table 5: TeamDynamix connector operation options
Connector Object | Option | All Possible Values | Description | Example |
---|---|---|---|---|
Asset | status_ids | Any TeamDynamix asset status ID | A comma-separated list of status IDs. Retrieves assets based on the specified status IDs. | Key: status_ids Value: 669,727 . This key and value combination only retrieves assets with the 669 or 727 status ID. |
Configuration Item | isActive | true, false | Retrieves configuration items based on whether they are active or not. | Key: isActive Value: true . This key and value combination only retrieves active configuration items. |
type_ids | Any TeamDynamix configuration item type ID | A comma-separated list of type IDs. Retrieves configuration items with the specified types. | Key: type_ids Value: 2 . This key and value combination only retrieves configuration items with type ID 2. | |
Group | isActive | true, false | Retrieves groups based on whether they are active or not. | Key: isActive Value: true . This key and value combination only retrieves active groups. |
Location | isActive | true, false | Retrieves locations based on whether they are active or not | Key: isActive Value: true . This key and value combination only retrieves active locations. |
People | isActive | true, false | Retrieves people based on whether they are active or not. | Key: isActive Value: true . This key and value combination only retrieves active people. |
Ticket | status | Cancelled, Completed, In Process, New, On Hold | A comma-separated list of ticket statuses. Retrieves tickets based on the specified status values, as determined by TeamDynamix. For additional information, see TeamDynamix documentation. | Key: status Value: In Process ,New . This key and value combination only retrieves tickets that are in process or new. |
The option keys and values are case-sensitive as they are shown in this documentation.
APIs
The TeamDynamix connector uses the TeamDynamix Web API. Specifically, it uses the following endpoints:
Table 6: TeamDynamix API Endpoints
Connector Object | API Endpoint |
---|---|
Asset | GET /api/{appId}/assets/search |
Configuration Item | GET /api/{appId}/cmdb/search |
Group | GET /api/groups/search |
Location | GET /api/locations/search |
People | GET /api/people/search |
Ticket | GET /api/{appId}/tickets/search |
Changelog
The TeamDynamix connector has undergone the following changes:
Table 7: TeamDynamix connector changelog
Version | Description |
---|---|
3.0.3 | The connector now checks the expiry of the authorization token and re-generate it if necessary. |
3.0.2 | - Fixed an issue where the connector sync was resulting in a 502 error due to an unsupported STATUS attribute type. - Updated the following attribute types to resolve data type mismatches:
|
3.0.1 | The connector now retrieves the following objects from Team Dynamix: Asset, Configuration Item, Group, Location, and People. |
3.0.0 | Initial Integration+ release. |