Skip to main content

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.

    note

    The 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 ObjectRequiredMaps to Data Model
AssetYesAsset
Configuration ItemNoNot mapped
GroupYesTeam
LocationNoNot mapped
PeopleYesPerson
TicketNoNot mapped
info

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 NameMaps to Attribute
AcquisitionDateLocal variable
AppIDLocal variable
AppNameLocal variable
AssetIDuid
Categorycategories
ConfigurationItemIDLocal variable
CreatedDatesourceCreatedDate
CreatedFullNameLocal variable
CreatedUidLocal variable
ExternalIDLocal variable
ExternalSourceIDLocal variable
ExternalSourceNameLocal variable
ExpectedReplacementDateLocal variable
FormIDLocal variable
FormNameLocal variable
IDuid
LocationIDLocal variable
LocationNameLocal variable
LocationRoomIDLocal variable
LocationRoomNameLocal variable
MaintenanceScheduleIDLocal variable
MaintenanceScheduleNameLocal variable
ManufacturerIDLocal variable
ManufacturerNameLocal variable
ModifiedDatesourceLastModified
ModifiedFullNameLocal variable
ModifiedUidLocal variable
Namename
OwningCustomerIDLocal variable
OwningCustomerNameLocal variable
OwningDepartmentIDLocal variable
OwningDepartmentNameLocal variable
ParentIDLocal variable
ParentNameLocal variable
ParentSerialNumberLocal variable
ParentTagLocal variable
ProductModelIDLocal variable
ProductModelNameLocal variable
PurchaseCostLocal variable
RequestingCustomerIDLocal variable
RequestingCustomerNameLocal variable
RequestingDepartmentIDLocal variable
RequestingDepartmentNameLocal variable
SerialNumberLocal variable
StatusIDLocal variable
StatusNamestatus
SupplierIDLocal variable
SupplierNameLocal variable
Tagtags
UriLocal variable
Group

Table 3: Group attribute mappings

Source Field NameMaps to Attribute
CreatedDatesourceCreatedDate
Descriptiondescription
ExternalIDLocal variable
IDuid
IsActivestatus
ModifiedDatesourceLastModified
Namename
People

Table 4: People attribute mappings

Source Field NameMaps to Attribute
AboutMeLocal variable
AlternateEmailemails
AlternateIDLocal variable
ApplyTechnicianSignatureToRepliesLocal variable
ApplyTechnicianSignatureToUpdatesAndCommentsLocal variable
AuthenticationProviderIDLocal variable
AuthenticationUserNameLocal variable
BEIDLocal variable
BEIDIntLocal variable
CompanyLocal variable
CostRateLocal variable
CreatedDatesourceCreatedDate
DefaultAccountIDLocal variable
DefaultAccountNamedepartment
DefaultPriorityIDLocal variable
DefaultPriorityNameLocal variable
DefaultRateLocal variable
Descriptiondescription
DisplayNameLocal variable
Emailemails
EndDateLocal variable
ExternalIDLocal variable
FaxLocal variable
FirstNamefirstName
FullNamename
HomeAddressLocal variable
HomeCityLocal variable
HomeCountryLocal variable
HomePhonehomePhone
HomeStateLocal variable
HomeZipLocal variable
IDuid
IMHandleLocal variable
IMProviderLocal variable
IsActivestatus
IsCapacityManagedLocal variable
IsConfidentialLocal variable
IsEmployeeLocal variable
JobTitlejobTitle
LastNamelastName
LocationIDLocal variable
LocationNameLocal variable
LocationRoomIDLocal variable
LocationRoomNameLocal variable
MiddleNameLocal variable
MobilePhonemobilePhone
ModifiedDatesourceLastModified
Namename
NicknameLocal variable
OtherPhoneotherPhone
PagerLocal variable
PrimaryClientPortalApplicationIDLocal variable
PrimaryEmailemails
PrimaryPhoneprimaryPhone
ProfileImageFileNameLocal variable
ReferenceIDLocal variable
ReportTimeAfterDateLocal variable
ReportsToFullNamereportsTo
ReportsToUIDLocal variable
ResourcePoolIDLocal variable
ResourcePoolNameLocal variable
SalutationLocal variable
SecurityRoleIDLocal variable
SecurityRoleNameLocal variable
ShouldReportTimeLocal variable
TechnicianSignatureLocal variable
TitlejobTitle
TZIDLocal variable
TZNameLocal variable
TypeIDLocal variable
UIDuid
UserNameuserName
WorkAddressLocal variable
WorkCityLocal variable
WorkCountryLocal variable
WorkPhoneworkPhone
WorkStateLocal variable
WorkZipLocal variable
WorkableHoursLocal variable
note

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 ObjectOptionAll Possible ValuesDescriptionExample
Assetstatus_idsAny TeamDynamix asset status IDA 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 ItemisActivetrue, falseRetrieves 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_idsAny TeamDynamix configuration item type IDA 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.
GroupisActivetrue, falseRetrieves groups based on whether they are active or not.Key: isActive Value: true. This key and value combination only retrieves active groups.
LocationisActivetrue, falseRetrieves locations based on whether they are active or notKey: isActive Value: true. This key and value combination only retrieves active locations.
PeopleisActivetrue, falseRetrieves people based on whether they are active or not.Key: isActive Value: true. This key and value combination only retrieves active people.
TicketstatusCancelled, Completed, In Process, New, On HoldA 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.
note

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 ObjectAPI Endpoint
AssetGET /api/{appId}/assets/search
Configuration ItemGET /api/{appId}/cmdb/search
GroupGET /api/groups/search
LocationGET /api/locations/search
PeopleGET /api/people/search
TicketGET /api/{appId}/tickets/search

Changelog

The TeamDynamix connector has undergone the following changes:

Table 7: TeamDynamix connector changelog

VersionDescription
3.0.3The 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:
  • Asset:
    • PURCHASE_COST: Float → Double
    • REQUESTING_DEPARTMENT_ID: Integer → String
  • Location:
    • IS_ROOM_REQUIRED: Boolean → String
  • People:
    • DEFAULT_PRIORITY_ID: Integer → String
    • WORK_ZIP: Integer → String
    • DEFAULT_RATE: Float → Double
    • COST_RATE: Float → Double
    • WORKABLE_HOURS: Float → Double
3.0.1The connector now retrieves the following objects from Team Dynamix: Asset, Configuration Item, Group, Location, and People.
3.0.0Initial Integration+ release.