Links

GetProjectsByGroup

This method can be used for the following functionality: Get details for all projects for a group this user is a member of.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

GET /api/ss/groups/:id/projects HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)
Identifier for the group.
Example:
GET /api/ss/groups/5e6880f33e6d520a26fef4b0/projects HTTP/1.1

Example

The following example is a cURL request to get all projects for a group.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/groups/5e6880f33e6d520a26fef4b0/projects' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an array of project objects.
{
"count": 999,
"projects": [
{
"project_id": "...",
"project_name": "...",
"project_code": "...",
"project_organization_code": "...",
"project_vulnerability_code": "..."
"project_groups": [
{
"id": "...",
"name": "..."
}
],
"project_status": "...",
"project_extended_status": "...",
"project_testing_progress": "100%",
"project_on_hold": "...",
"project_start_date": "...",
"project_end_date": "...",
"project_scope": [
"..."
],
"project_scoring": "...",
"project_team_notifications": [
"..."
],
"project_admin_notifications": [
"..."
],
"project_start_stop_testing_email": "...",
"project_start_stop_testing_email_additional_recipients": [
"..."
],
"project_new_vulnerability_email_type": "...",
"project_new_vulnerability_email": "...",
"project_new_vulnerability_email_additional_recipients": [
"..."
],
"project_forced_emails": [
"..."
],
"project_executive_summary": "...",
"project_attack_chains": [
{
"total": 999
}
],
"project_team": [
{
"id": "...",
"user_id": "...",
"first_name": "...",
"last_name": "...",
"access_level": "...",
"role": "...",
"email_notifications": [
"..."
],
"last_modified": "..."
}
],
"project_hold_history": [
{
"status": "...",
"reason": "...",
"created": "..."
}
],
"project_retests_requested": 999,
"project_retests_completed": 999,
"project_retesting_history: [
{
"retesting_round": 1,
"retesting_round_status": "...",
"retesting_custom_round_name": "...",
"retesting_custom_status_name": "...",
"retesting_round_actioned_by": {
"user_id": "...",
"user_first_name": "...",
"user_last_name": "..."
},
"retesting_round_vulnerabilities": [
{
"vulnerability_id": "...",
"vulnerability_alternate_id": "...",
"vulnerability_title": "...",
}
],
"created": "..."
}
],
"project_streams": [
{
"id": "...",
"name": "...",
"stream_portfolios": [
{
"id": "...",
"name": "...",
}
]
}
],
"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_created": "...",
"project_last_modified": "...",
"project_custom_fields": [
{
"key": "...",
"value": "...",
"type": "Tag/Field"
}
]
}
]
}