ThreatConnect App Framework (TcEx)

Release 0.9.1.

Table of Contents

• Authorization (Token / HMAC)
  • Token Refresh
  • HMAC Authorization
• Batch
  • External ID (xid)
  • Groups
  • Indicators
  • Associations
  • Submit
• Building Apps
  • Build Local Modules
  • Testing Apps Locally
  • Packaging an App
• Data Filter
• Development Tools
• Exit
  • Setting Exit Code
  • Immediate Exit on Failure
  • Job App Exit Codes
  • Playbook App Exit Codes
• Examples
  • Custom Metric Examples
  • Data Store Examples
  • Indicator Resource Examples
  • Security Label Resource Examples
  • Tag Resource Examples
• Install JSON
  • Schema Definition
• Jobs
  • Groups
  • Group to Indicator Associations
  • Group to Group Associations
  • Indicators
  • Indicator to Indicator Associations
  • File Occurrence
  • Sample Job Flow
• Logging
• Message TC
• tcex
  • tcex package
• Metrics
  • Metrics Instance
  • Add Metrics
  • Add Keyed Metrics
• Notifications
  • Notification Instance
  • Recipients
  • Organization
  • Send
• Parser / Args
  • API Arguments
  • Batch Arguments
  • Playbook Arguments
  • Standard Arguments
  • Custom Argument
• Playbooks
  • Understanding Playbooks
  • Playbook Flow
  • Input Variables
  • Output Variables
  • Variable Types
• Proxies
  • Example Request using Proxy
• Requests
  • Request External
  • Request TC
• Resources
  • Custom Metrics Resource
  • Data Store Resource
  • Group Resources
  • Indicator Resources
  • Owner Resources
  • Security Label Resources
  • Tag Resources
  • Task Resources
  • Victim Resources
• Results TC
• Release Notes
  • 0.8.x
  • 0.7.x
  • 0.6.x
  • 0.5.x
  • 0.4.x
  • 0.3.x
  • 0.2.x
  • 0.1.x
  • 0.0.x
• Utils
  • Format Date Time
  • Date to Datetime
  • Human Time to Datetime
  • Unix Time to Datetime

Overview

The ThreatConnect ™ TcEx App Framework provides commonly used Classes and Methods for writing ThreatConnect Exchange Apps. The Framework is intended to speed up the development process and ensure Apps contains the core functionality required.

This documentation provides a detailed level view of the TcEx Framework as well as some App overviews. The Building Apps section is a good place to start when working on your first app. The section overviews are intended to provide details of the core functionality of an App and the code references should provide further information for more in depth questions.

Features

• Automatic authorization for HMAC and Token base authentication when using Resources functionality. This allows the App to work seamlessly on both ThreatConnect Exchange Platform and the ThreatConnect Integration Server.
• App logger that supports both filesystem and API logging (Logging).
• Batch add through Jobs job module.
• Common methods for proper App execution: exit codes (Exit); exit messages (Message TC) and more

Indices and tables

• Index
• Module Index