Authentication

You must first import the base Threatq object before performing any SDK operations. The Threatq object serves as the primary interface for authenticating and interacting with the ThreatQ API.

1. Import the base Threatq object: 
   from threatqsdk import Threatq

   Copy Code

2. Authenticate with the ThreatQ API using one of the following methods:
   • OAuth Client Credentials (recommended)
     tq_host = ' < Your ThreatQ Instance IP > '
     clientID = ' < OAuth Client ID > '
     clientsecretID = ' <OAuth Client Secret> '
     tq = Threatq(host,(clientID,clientsecretID),True)

     Copy Code

     Replace the tq_host, clientID, and clientsecretID entries with your information. Follow the steps provided in the Creating OAuth Client Credentials section below.
     
     You must use the flag True in the final line, as shown above. Failing to use this flag will result in the application defaulting to the username/password method.  

   • Username and Password Authentication
     tq_host = 'https://localhost:8443'
     username = '< USERNAME >'
     password = '< PASSWORD >'
     clientid = ' < CLIENT ID > '
     tq = Threatq(tq_host, {'clientid': clientid, 'auth': { 'email': username, 'password': password}})

     Copy Code

     Replace the USERNAME, PASSWORD, and CLIENT ID with your information. This information can be obtained by viewing your user profile in ThreatQ.

Creating OAuth Client Credentials

OAuth Client Credentials provide a secure method for custom integrations and automation workflows. The process below provides steps on generating OAuth Client Credentials. See the OAuth Credentials topic for additional information regarding this command.