Project Created

Getting Started

This page will help you with subscribing to the project-created event.

This event can be used for the following:

  • Get details for all new projects created, for which you have access to;

Prerequisites

In order to subscribe to this event, you must have:

  • Access to the project-created event (see My Events to confirm).

  • A working client (see Setting Up Your Client for details).

  • Valid API Key (see Authentication for your key).

  • Network access to your AttackForge Enterprise tenant.

Subscribing To Event

  • NodeJS

  • Python

  • .NET

  • Java

  • Go

NodeJS

NodeJS Prerequisites

In order to subscribe to this event using the NodeJS client, you must have:

  • NodeJS v10+ installed

  • NPM installed

  • A working NodeJS client (see Setting Up Your Client for details).

Client configuration

Open a terminal and navigate to the client directory.

From the client directory, run following command, substituting variables below with your configuration details:

$ HOSTNAME="YOUR-AFE-HOSTNAME" EVENTS="project-created" X_SSAPI_KEY="YOUR-API-KEY" node .

An example is included below for reference:

$ HOSTNAME="demo.attackforge.com" EVENTS="project-created" X_SSAPI_KEY="q9ef672kqZIQymCZRuiKMeWbeaXEzBzqRCfGcpWEpoBNU2Bk4UmtktsZVDDgRzlC0BOHH9x0y4EzbBGeSKO9PRskEmHATXHs2sVe7tS98U0DuDFjH0RdPFWUpgZDWgIESy9yNDesm6Xi8C9HsikddyBKsATXat2604dPrr4Ca86J8Y5IkEnqUwYzw3MoSbzHeXZ0DKHqKz6Icv9dtrsnAFzpXg1P423uRllq4LqFjP4J8hAtrWZ9296h3uh9B5Vp" node .

If your client is successfully subscribed to this event, you should see similar output in your terminal:

Subscribed to the following events: [ 'project-created' ]

Your client is now working and you will see new events output to the terminal as they are pushed from AttackForge.

You can now work on your integration code to start actioning these events. Open index.js with a text editor from your client directory. Your code will replace the following section within this file:

/* ENTER YOUR INTEGRATION CODE HERE */
/* method contains the event type e.g. vulnerability-created */
/* params contains the event body e.g. JSON object with timestamp & vulnerability details */

Python

Python Prerequisites

In order to subscribe to this event using the Python client, you must have:

  • Python3 installed

  • PIP installed

  • A working Python client (see Setting Up Your Client for details).

Client configuration

Open a terminal and navigate to the client directory.

From the client directory, run following command, substituting variables below with your configuration details:

$ HOSTNAME="YOUR-AFE-HOSTNAME" EVENTS="project-created" X_SSAPI_KEY="YOUR-API-KEY" python3 main.py

An example is included below for reference:

$ HOSTNAME="demo.attackforge.com" EVENTS="project-created" X_SSAPI_KEY="q9ef672kqZIQymCZRuiKMeWbeaXEzBzqRCfGcpWEpoBNU2Bk4UmtktsZVDDgRzlC0BOHH9x0y4EzbBGeSKO9PRskEmHATXHs2sVe7tS98U0DuDFjH0RdPFWUpgZDWgIESy9yNDesm6Xi8C9HsikddyBKsATXat2604dPrr4Ca86J8Y5IkEnqUwYzw3MoSbzHeXZ0DKHqKz6Icv9dtrsnAFzpXg1P423uRllq4LqFjP4J8hAtrWZ9296h3uh9B5Vp" python3 main.py

If your client is successfully subscribed to the events, you should see similar output in your terminal:

Subscribed to the following events: [ 'project-created' ]

Your client is now working and you will see new events output to the terminal as they are pushed from AttackForge.

You can now work on your integration code to start actioning these events. Open main.py with a text editor from your client directory. Your code will replace the following section within this file:

# ENTER YOUR INTEGRATION CODE HERE
# method contains the event type e.g. vulnerability-created
# params contains the event body e.g. JSON object with timestamp & vulnerability details

.NET

.NET Prerequisites

In order to subscribe to this event using the .NET client, you must have:

  • .NET 5.0 SDK installed

  • A working .NET client (see Setting Up Your Client for details).

Client configuration

Open a terminal and navigate to the client directory.

From the client directory, run following command, substituting variables below with your configuration details:

$ HOSTNAME="YOUR-AFE-HOSTNAME" EVENTS="project-created" X_SSAPI_KEY="YOUR-API-KEY" dotnet run

An example is included below for reference:

$ HOSTNAME="demo.attackforge.com" EVENTS="project-created" X_SSAPI_KEY="q9ef672kqZIQymCZRuiKMeWbeaXEzBzqRCfGcpWEpoBNU2Bk4UmtktsZVDDgRzlC0BOHH9x0y4EzbBGeSKO9PRskEmHATXHs2sVe7tS98U0DuDFjH0RdPFWUpgZDWgIESy9yNDesm6Xi8C9HsikddyBKsATXat2604dPrr4Ca86J8Y5IkEnqUwYzw3MoSbzHeXZ0DKHqKz6Icv9dtrsnAFzpXg1P423uRllq4LqFjP4J8hAtrWZ9296h3uh9B5Vp" dotnet run

If your client is successfully subscribed to the events, you should see similar output in your terminal:

Subscribed to the following events: [ 'project-created' ]

Your client is now working and you will see new events output to the terminal as they are pushed from AttackForge.

You can now work on your integration code to start actioning these events. Open Program.cs with a text editor from your client directory. Your code will replace the following section within this file:

/* ENTER YOUR INTEGRATION CODE HERE */
/* method contains the event type e.g. vulnerability-created */
/* params contains the event body e.g. JSON object with timestamp & vulnerability details */

Java

Java Prerequisites

In order to subscribe to this event using the Java client, you must have:

  • OpenJDK 11 installed

  • Maven installed

  • A working Java client (see Setting Up Your Client for details).

Client configuration

Open a terminal and navigate to the client directory.

From the client directory, run following command, substituting variables below with your configuration details:

$ HOSTNAME="YOUR-AFE-HOSTNAME" EVENTS="project-created" X_SSAPI_KEY="YOUR-API-KEY" java -jar target/afe-ssapi-events-java-client-1.0-SNAPSHOT-jar-with-dependencies.jar

An example is included below for reference:

$ HOSTNAME="demo.attackforge.com" EVENTS="project-created" X_SSAPI_KEY="q9ef672kqZIQymCZRuiKMeWbeaXEzBzqRCfGcpWEpoBNU2Bk4UmtktsZVDDgRzlC0BOHH9x0y4EzbBGeSKO9PRskEmHATXHs2sVe7tS98U0DuDFjH0RdPFWUpgZDWgIESy9yNDesm6Xi8C9HsikddyBKsATXat2604dPrr4Ca86J8Y5IkEnqUwYzw3MoSbzHeXZ0DKHqKz6Icv9dtrsnAFzpXg1P423uRllq4LqFjP4J8hAtrWZ9296h3uh9B5Vp" java -jar target/afe-ssapi-events-java-client-1.0-SNAPSHOT-jar-with-dependencies.jar

If your client is successfully subscribed to the events, you should see similar output in your terminal:

Subscribed to the following events: [ 'project-created' ]

Your client is now working and you will see new events output to the terminal as they are pushed from AttackForge.

You can now work on your integration code to start actioning these events. Open ./src/main/java/com/attackforge/App.java with a text editor from your client directory. Your code will replace the following section within this file:

/* ENTER YOUR INTEGRATION CODE HERE */
/* method contains the event type e.g. vulnerability-created */
/* params contains the event body e.g. JSON object with timestamp & vulnerability details */

Go

Go Prerequisites

In order to subscribe to this event using the Go client, you must have:

  • Go installed

  • A working Go client (see Setting Up Your Client for details).

Client configuration

Open a terminal and navigate to the client directory.

From the client directory, run following command, substituting variables below with your configuration details:

$ HOSTNAME="YOUR-AFE-HOSTNAME" EVENTS="project-created" X_SSAPI_KEY="YOUR-API-KEY" ./afe-ssapi-events-go-client

An example is included below for reference:

$ HOSTNAME="demo.attackforge.com" EVENTS="project-created" X_SSAPI_KEY="q9ef672kqZIQymCZRuiKMeWbeaXEzBzqRCfGcpWEpoBNU2Bk4UmtktsZVDDgRzlC0BOHH9x0y4EzbBGeSKO9PRskEmHATXHs2sVe7tS98U0DuDFjH0RdPFWUpgZDWgIESy9yNDesm6Xi8C9HsikddyBKsATXat2604dPrr4Ca86J8Y5IkEnqUwYzw3MoSbzHeXZ0DKHqKz6Icv9dtrsnAFzpXg1P423uRllq4LqFjP4J8hAtrWZ9296h3uh9B5Vp" ./afe-ssapi-events-go-client

If your client is successfully subscribed to this event, you should see similar output in your terminal:

Subscribed to the following events: [ 'project-created' ]

Your client is now working and you will see new events output to the terminal as they are pushed from AttackForge.

You can now work on your integration code to start actioning these events. Open main.go with a text editor from your client directory. Your code will replace the following section within this file:

/* ENTER YOUR INTEGRATION CODE HERE */
/* method contains the event type e.g. vulnerability-created */
/* params contains the event body e.g. JSON object with timestamp & vulnerability details */

Example Response

The event emitted will include the following information:

method: project-created
params:
{
  timestamp: 2021-01-01T00:00:00.000Z,
  data:
  {
    "project_id": "60fe2f7747d2c400306bd808",
    "project_name": "PROJECT-X",
    "project_code": "PROJECT123",
    "project_organization_code": "GLOBEX-CORP-99",
    "project_vulnerability_code": "PROJX",
    "project_groups": [
      {
        "id": "60d59ce05e2fc4002f1r1B1p", 
        "name": "US Technology Group"
      }
    ],
    "project_status": "Testing",
    "project_on_hold": "No",
    "project_start_date": "2021-01-10T00:00:00.000Z",
    "project_end_date": "2021-01-15T00:00:00.000Z",
    "project_scope": [
      "ASSET-1",
      "ASSET-2"
    ],
    "project_scoring": "CVSSv3.1",
    "project_team_notifications": [
      "Critical",
      "High"
    ],
    "project_admin_notifications": [
      "Retesting"
    ],
    "project_start_stop_testing_email_additional_recipients": [
      "soc@attackforge.com"
    ],
    "project_new_vulnerability_email_additional_recipients": [
      "soc@attackforge.com"
    ],
    "project_forced_emails": [
      "New Critical Vulnerability",
      "New High Vulnerability"
    ],
    "project_retests_requested": 999,
    "project_retests_completed": 999,
    "project_streams": [
      {
        "id": "61959171af11f3003c31eb70",
        "name": "Web Pentests",
        "stream_portfolios": [
          {
            "id": "61959171af11f3003c31eb6f",
            "name": "ABC.COM",
          }
        ]
      }
    ],
    "project_total_assets": 999,
    "project_total_testcases": 999,
    "project_not_tested_testcases": 999,
    "project_in_progress_testcases": 999,
    "project_tested_testcases": 999,
    "project_not_applicable_testcases": 999,
    "project_total_vulnerabilities": 999,
    "project_open_vulnerabilities": 999,
    "project_closed_vulnerabilities": 999,
    "project_retest_vulnerabilities": 999,
    "project_critical_vulnerabilities": 999,
    "project_critical_open_vulnerabilities": 999,
    "project_critical_ready_for_retest_vulnerabilities": 999,
    "project_critical_closed_vulnerabilities": 999,
    "project_high_vulnerabilities": 999,
    "project_high_open_vulnerabilities": 999,
    "project_high_ready_for_retest_vulnerabilities": 999,
    "project_high_closed_vulnerabilities": 999,
    "project_medium_vulnerabilities": 999,
    "project_medium_open_vulnerabilities": 999,
    "project_medium_ready_for_retest_vulnerabilities": 999,
    "project_medium_closed_vulnerabilities": 999,
    "project_low_vulnerabilities": 999,
    "project_low_open_vulnerabilities": 999,
    "project_low_ready_for_retest_vulnerabilities": 999,
    "project_low_closed_vulnerabilities": 999,
    "project_info_vulnerabilities": 999,
    "project_info_open_vulnerabilities": 999,
    "project_info_ready_for_retest_vulnerabilities": 999,
    "project_info_closed_vulnerabilities": 999,
    "project_zeroday_vulnerabilities": 999,
    "project_easily_exploitable_vulnerabilities": 999,
    "project_cwe_top_25_vulnerabilities": 999,
    "project_owasp_top_10_vulnerabilities": 999,
    "project_pending_vulnerabilities": 999,
    "project_retests_requested": 999,
    "project_retests_completed": 999,
    "project_created": "2021-11-24T22:56:32.118Z",
    "project_last_modified": "2021-11-24T22:56:32.118Z",
    "project_custom_fields": [
      {
        "key": "...",
        "value": "...",
        "type": "Tag/Field"
      }
    ]
  }
}
PreviousGETTING STARTEDNextProject Updated

Last updated

Check YouTube for more tutorials: https://youtube.com/@attackforge