The requestType field is mandatory for all requests.

Date format in all responses is "yyyy-MM-dd".

None of the results are sorted in any order.

For customers who have enabled vulnerability based alerting, there are several changes to API version 1.3. Refer here for details.

{
	"requestType" : "getOrganizationAlerts",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductAlerts",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectAlerts",
    "userKey": "user_key", 
	"projectToken" : "project_token"
}

For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details.

{
	"requestType" : "getAlertsByProjectTag",
    "userKey": "user_key", 
	"orgToken" : "orgToken",
    "tagKey":"key1",
    "tagValue":"value1"
}

"apiAlertInfo" : [
	{
		"type" : "alert_type",
		"level" : "alert_level",
		"library": {
  		  "keyUuid": "library_unique_id",
		  "filename": "library_file_name",
		  "name": "library_name",
		  "groupId": "library_group_id",
		  "artifactId": "library_artifact_id",
		  "version": "library_version",
		  "sha1": "library_sha1",
		  "type": "library_type",
		  "description": "library_description",
		  "references": {
        	"url": "library_url",
	        "pomUrl": "library_pom_url",
    	    "scmUrl": "library_scm_url"
  	      },
          "licenses": [
           {
            "name": "library_license_name",
            "url": "library_license_url",
            "profileInfo": {
                "copyrightRiskScore": "library_license_copyright_risk_score",
                "patentRiskScore": "library_patent_risk_score",
                "copyleft": "library_license_patent_copyleft",
                "linking": "library_license_linking",
                "royaltyFree": "library_license_royalty_free"
            }
           }
          ]
        },
	    "project" : "project_name",
	    "directDependency": true,
	    "description" : "alert_description",
	    "date" : "alert_creation_date",
	    "time" : "alert_creation_time_in_epoch_format"
        "alertUuid": "6f07c029-f211-4d14-bbb6-5628aa87a1d1"
	}
] 

"apiAlertInfo" : [
	{
		"type" : "alert_type",
		"level" : "alert_level",
		"library": {
  		  "keyUuid": "library_unique_id",
		  "filename": "library_file_name",
		  "name": "library_name",
		  "groupId": "library_group_id",
		  "artifactId": "library_artifact_id",
		  "version": "library_version",
		  "sha1": "library_sha1",
		  "type": "library_type",
		  "description": "library_description",
		  "references": {
        	"url": "library_url",
	        "pomUrl": "library_pom_url",
    	    "scmUrl": "library_scm_url"
  	      },
          "licenses": [
           {
            "name": "library_license_name",
            "url": "library_license_url",
            "profileInfo": {
                "copyrightRiskScore": "library_license_copyright_risk_score",
                "patentRiskScore": "library_patent_risk_score",
                "copyleft": "library_license_patent_copyleft",
                "linking": "library_license_linking",
                "royaltyFree": "library_license_royalty_free"
            }
           }
          ]
        },
	    "project" : "project_name",
	    "directDependency": false,
	    "description" : "alert_description",
	    "date" : "alert_creation_date",
	    "time" : "alert_creation_time_in_epoch_format"
        "alertUuid": "6f07c029-f211-4d14-bbb6-5628aa87a1d1"
   }
]

Alert level is either minor or major.

For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details.

{
   "requestType" : "getOrganizationIgnoredAlerts",
   "userKey": "user_key", 
   "orgToken" : "organization_api_key"
}

{
    "requestType" : "getProductIgnoredAlerts",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
   "requestType" : "getProjectIgnoredAlerts",
    "userKey": "user_key", 
   "projectToken" : "project_token"
}

{
    "alerts": [
        {
            "vulnerability": {
                "name": "CVE-2019-10202",
                "type": "CVE",
                "severity": "high",
                "score": 7.5,
                "cvss3_score": 0.0,
                "publishDate": "2019-10-01",
                "url": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-10202",
                "description": "A series of deserialization vulnerabilities have been discovered in Codehaus 1.9.x implemented in EAP 7. This CVE fixes CVE-2017-	17485, CVE-2017-7525, CVE-2017-15095, CVE-2018-5968, CVE-2018-7489, CVE-2018-1000873, CVE-2019-12086 reported for FasterXML jackson-databind by implementing a whitelist approach that will mitigate these vulnerabilities and future ones alike.",
                "allFixes": [],
                "references": []
            },
            "type": "SECURITY_VULNERABILITY",
            "level": "MAJOR",
            "library": {
                "keyUuid": "029092aa-fe0c-4ab5-ae02-a5a05c9cb8c5",
                "keyId": 13673550,
                "filename": "jackson-mapper-asl-1.9.2.jar",
                "type": "Java",
                "description": "Data Mapper package is a high-performance data binding package\nbuilt on Jackson JSON processor",
                "references": {
                    "url": "http://jackson.codehaus.org",
                    "issueUrl": "http://jira.codehaus.org/browse/JACKSON",
                    "pomUrl": "https://index.whitesourcesoftware.com/nexus/content/groups/public-on-prem/org/codehaus/jackson/jackson-mapper-asl/1.9.2/jackson-mapper-asl-1.9.2.pom"
                },
                "sha1": "95400a7922ce75383866eb72f6ef4a7897923945",
                "name": "Data Mapper for Jackson",
                "artifactId": "jackson-mapper-asl",
                "version": "1.9.2",
                "groupId": "org.codehaus.jackson",
                "licenses": [
                    {
                        "name": "Apache 2.0",
                        "url": "http://www.opensource.org/licenses/Apache-2.0",
                        "profileInfo": {
                            "copyrightRiskScore": "THREE",
                            "patentRiskScore": "ONE",
                            "copyleft": "NO",
                            "linking": "DYNAMIC",
                            "royaltyFree": "CONDITIONAL"
                        },
                        "references": [
                            {
                                "referenceType": "POM file",
                                "reference": "https://index.whitesourcesoftware.com/nexus/content/groups/public-on-prem/org/codehaus/jackson/jackson-mapper-	asl/1.9.2/jackson-mapper-asl-1.9.2.pom"
                            }
                        ]
                    }
                ]
            },
            "project": "wss-dal-entity-mysql",
            "projectId": 1976,
            "projectToken": "fe305449dc244aeb8f0dd729182669b1251ceabede7548b4a86e61b3903f02e4",
            "directDependency": true,
            "description": "Medium:1,",
            "date": "2019-10-10",
            "time": 1570703663000,
            "alertUuid": "e2d992ce-eaa6-4469-98b3-221e35d6f5fe",
            "comments": "Ignore this alert"
        },
        {
            "vulnerability": {
                "name": "CVE-2019-10202",
                "type": "CVE",
                "severity": "high",
                "score": 7.5,
                "cvss3_score": 0.0,
                "publishDate": "2019-10-01",
                "url": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-10202",
                "description": "A series of deserialization vulnerabilities have been discovered in Codehaus 1.9.x implemented in EAP 7. This CVE fixes CVE-2017-17485, CVE-2017-7525, CVE-2017-15095, CVE-2018-5968, CVE-2018-7489, CVE-2018-1000873, CVE-2019-12086 reported for FasterXML jackson-databind by implementing a whitelist approach that will mitigate these vulnerabilities and future ones alike.",
                "allFixes": [],
                "references": []
            },
            "type": "SECURITY_VULNERABILITY",
            "level": "MAJOR",
            "library": {
                "keyUuid": "029092aa-fe0c-4ab5-ae02-a5a05c9cb8c5",
                "keyId": 13673550,
                "filename": "jackson-mapper-asl-1.9.2.jar",
                "type": "Java",
                "description": "Data Mapper package is a high-performance data binding package\nbuilt on Jackson JSON processor",
                "references": {
                    "url": "http://jackson.codehaus.org",
                    "issueUrl": "http://jira.codehaus.org/browse/JACKSON",
                    "pomUrl": "https://index.whitesourcesoftware.com/nexus/content/groups/public-on-prem/org/codehaus/jackson/jackson-mapper-asl/1.9.2/jackson-mapper-asl-1.9.2.pom"
                },
                "sha1": "95400a7922ce75383866eb72f6ef4a7897923945",
                "name": "Data Mapper for Jackson",
                "artifactId": "jackson-mapper-asl",
                "version": "1.9.2",
                "groupId": "org.codehaus.jackson",
                "licenses": [
                    {
                        "name": "Apache 2.0",
                        "url": "http://www.opensource.org/licenses/Apache-2.0",
                        "profileInfo": {
                            "copyrightRiskScore": "THREE",
                            "patentRiskScore": "ONE",
                            "copyleft": "NO",
                            "linking": "DYNAMIC",
                            "royaltyFree": "CONDITIONAL"
                        },
                        "references": [
                            {
                                "referenceType": "POM file",
                                "reference": "https://index.whitesourcesoftware.com/nexus/content/groups/public-on-prem/org/codehaus/jackson/jackson-mapper-asl/1.9.2/jackson-mapper-asl-1.9.2.pom"
                            }
                        ]
                    }
                ]
            },
            "project": "wss-server",
            "projectId": 1978,
            "projectToken": "2e139a0b5c494042b2c92807bc595c0bdd4645ae5ab34800a968999140e38e24",
            "directDependency": true,
            "description": "Medium:1,",
            "date": "2019-10-10",
            "time": 1570703663000,
            "alertUuid": "5f869dba-9d5d-437a-8a03-b51c23997f99",
            "comments": "Ignore this alert as well"
        }
    ]
}

"vulnerability": {
	"name": "vulnerability_name",
	"type": "vulnerability_type",
    "severity": "vulnerability_severity",
	"score": cvss_2_vulnerability_score,
	"cvss3_severity": "cvss_3_score_severity",
	"cvss3_score": cvss_3_vulnerability_score,
    "publishDate": "vulnerability_publish_date"	
    "scoreMetadataVector": "cvss_3_metadata_vector",
	"url": "URL_of_vulnerability" 
    "description": "vulnerability_description",
	"topFix": {
    	"vulnerability": "vulnerability_fix_name",
      	"type": "vulnerability_fix_type",
      	"origin": "origin_of_fix",
      	"url": "URL_of_fix",
      	"fixResolution": "fix_resolution",
      	"date": "date_of_fix",
     	"message": "summary_of_fix",
      	"extraData": "additional_data_on_fix"
   },
   "allFixes": [{
   		"vulnerability": "vulnerability_fix_name",
        "type": "vulnerability_fix_type",
        "origin": "origin_of_fix",
        "url": "URL_of_fix",
        "fixResolution": "fix_resolution",
        "date": "date_of_fix",
        "message": "details_on_fix",
        "extraData": "additional_data"
   }]
}

For customers who have enabled Security Alerts: View By Vulnerability, there are several changes to API version 1.3. Refer here for details.

{
	"requestType" : "getOrganizationAlertsByType",
    "userKey": "user_key", 
	"alertType" : "alert_type",
	"orgToken" : "organization_api_key",
	"fromDate" : "2016-01-01 10:00:00",
	"toDate" : "2016-01-02 10:00:00"
}

{
	"requestType" : "getProductAlertsByType",
     "userKey": "user_key", 
	"alertType" : "alert_type",
	"productToken" : "product_token",
	"fromDate" : "2016-01-01 11:00:31",
	"toDate" : "2016-01-02 11:00:31"
}

{
	"requestType" : "getProjectAlertsByType",
    "userKey": "user_key", 
	"alertType" : "alert_type",
	"projectToken" : "project_token",
	"fromDate" : "2016-01-01 11:00:00",
	"toDate" : "2016-01-02 11:00:00",
    "sourceFiles": true
}

Same as alerts response

'alertUuids' and 'comments' are mandatory fields. 

{
  "requestType":"ignoreAlerts",
  "orgToken": "organization_api_key",
  "userKey": "user_key",
  "alertUuids": ["22f72c74-c2ea-4ed9-b37f-75d77bc52045","22f72c74-c2ea-4ed9-b37f-75d77bc52046"],
  "comments": "alerts not relevant to service"
}

{
    "message": "Successfully ignored alerts"
}

{
    "requestType":"setAlertsStatus",
    "orgToken":"organization_api_key",
    "userKey": "user_key",
    "alertUuids": ["alert1_UUID", "alert2_UUID"],
    "comments": "Enter you comment here",
    "status": "Active"
}

{
    "message": "Successfully set the alert's status"
}

{
      "userKey": "user_key", 
      "orgToken": "organization_api_key",
      "requestType": "getChangesReport",
	  "startDateTime": "2019-08-21 08:08:08" 	
}

{
    "changes": [
        {
            "startDateTime": "2018-07-04 09:07:21",
            "category": "METADATA",
            "type": "SOURCE_MATCHING",
            "changeType": "CHANGED",
            "scope": "SOURCE_FILE",
            "scopeName": "activation_mode.h",
            "scopeId": 2922950,
            "beforeChange": [
                "tensorflow-v1.4.0-rc0"
            ],
            "afterChange": [
                "tensorflow-v1.4.0-rc0"
            ],
            "operator": "USER",
            "userEmail": "john@doe.com",
            "productId": 69491,
            "productName": "tensorflow",
            "projectId": 338568,
            "projectName": "tensor",
            "comment": "changed lib of source file"
        }
    ]
}

{
	"requestType" : "getOrganizationLicenses",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "excludeProjectOccurrences" : true/false
}

{
	"requestType" : "getProductLicenses",
    "userKey": "user_key", 
	"productToken" : "product_token",
 	"excludeProjectOccurrences" : true/false
}

{
	"requestType" : "getProjectLicenses",
    "userKey": "user_key", 
	"projectToken" : "project_token",
 	"excludeProjectOccurrences" : true/false
}

"libraries" : [
	{
        "licenses" : [
            "license_name_1",
            "license_name_2", 
            "spdxName":"license_spdx_name"
        ],
        "copyrightReferences": [
            {
            "copyright": "library_copyright_text",
            "startYear": "library_copyright_start_year"
            }
        ],
        "keyUuid": "library_key_uuid",
        "keyId": "library_key_id",
        "filename": "library_file_name",
        "name" : "libarary_name",
        "groupId" : "library_group_id",
        "artifactId" : "library_artifact_id",
        "version" : "library_version",
        "sha1" : "library_sha1",
        "languages": "library_language",
        "references" : {"url":"library_url",
                        "downloadLink":"library_download_link"
                        }
    }
]

{
	"requestType" : "getOrganizationLicenseHistogram",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductLicenseHistogram",
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectLicenseHistogram",
    "userKey": "user_key", 
	"projectToken" : "project_token"
}

{
	"licenseHistogram" : {
		"Apache 2.0" : 2,
		"BSD 3" : 2,
		"GPL 3.0" : 1,
	}
}

{
"requestType":"getOrganizationDetails",
"orgToken":"org_token",
“userKey”:”user_key”
}

{
"orgName": "Org A",
"orgToken": "Org_a_token"
"creationDate": "2016-01-01 12:00:00"
"numberOfProducts": "15"
"numberOfProjects": "105"
"numberOfGroups": "2"
"numberOfUsers": "3"
}

{
  "requestType":"getAllProducts",
  "userKey": "user_key", 
  "orgToken":"org_token"
}

{
    "products": [
        {
            "productName": "Product A",
            "productToken": "product_a_token"
        },
        {
            "productName": "Product B",
            "productToken": "product_b_token"
        }
    ],
    "message": "Success"
}

{
  "requestType":"getAllProjects",
  "userKey": "user_key", 
  "productToken":"product_token"
}

{
    "projects": [
        {
            "projectName": "project_a",
            "projectToken": "project_a_token"
        },
        {
            "projectName": "project_b",
            "projectToken": "project_b_token"
        }
    ],
    "message": "Success"
}

{
    "requestType" : "getOrganizationInHouseLibraries",
    "orgToken" : "organization_api_key",
    "userKey": "user_key"
}

{
    "requestType" : "getProductInHouseLibraries",
    "productToken" : "product_token",
    "userKey": "user_key"
}

{
    "requestType" : "getProjectInHouseLibraries",
    "projectToken" : "project_token",
    "userKey": "user_key"
}

"libraries" : [
    {
        "matchType" : "manual",
        "comment": "manually set to in-house",
        "keyUuid": "library_unique_id",
        "filename": "library_file_name",
        "groupId": "library_group_id",
        "artifactId": "library_artifact_id",
        "version": "library_version",
        "sha1": "library_sha1",
        "type": "library_type",
        "description": "library_description",
        "productName" : "product_name",
        "productToken" : "product_token",
        "projectName" : "project_name",
        "projectToken" : "project_token" 
    },
    {
        "matchType" : "automatic",
        "pattern" : "common-*",
        "keyUuid": "library_unique_id",
        "filename": "library_file_name",
        "groupId": "library_group_id",
        "artifactId": "library_artifact_id",
        "version": "library_version",
        "sha1": "library_sha1",
        "type": "library_type",
        "description": "library_description",
        "productName" : "product_name",
        "productToken" : "product_token",
        "projectName" : "project_name",
        "projectToken" : "project_token  
    }
]

{
    "requestType": "unmarkManualInHouseLibrary",
    "userKey": "user_key",
    "orgToken": "organization_api_key",
    "keyUuid" : "library_UUID"
}

{
    "message": "Successfully unmarked in-house library"
}

{
	"requestType" : "getOrganizationProjectVitals",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductProjectVitals",
    "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectVitals",
     "userKey": "user_key", 
	"projectToken" : "project_token"
}

{
	"projectVitals":[
    	{
			"pluginName":"fs-agent:18.2.2",
			"name": "My Project",
			"token": "project_token",
			"uploadedBy": "name_of_user_who_ran_scan", 
			"creationDate": "2016-01-01 12:00:00",
			"lastUpdatedDate": "2016-02-02 16:50:59"
		}
	]
}

{
	"requestType" : "getOrganizationProductVitals",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"productVitals":[
    	{
			"name": "My Product",
			"token": "product_token",
			"creationDate": "2016-01-01 12:00:00",
			"lastUpdatedDate": "2016-02-02 16:50:59"
		}
	]
}

{
   "requestType": "createGlobalOrg",
   "userKey": "user_key",
   "name": "global_org_name",
   "accountAdminEmail": "enter_account_admin_email@here.com"
}

{
   "globalOrgToken": "global_org_token"
}

{
   "requestType": "assignGlobalOrgToOrg",
   "userKey": "user_key",
   "orgToken": "org_token",
   "globalOrgToken": "global_org_token"
}

{
   "requestType": "removeGlobalOrgFromOrg",
   "userKey": "user_key",
   "orgToken": "org_token",
   "globalOrgToken": "global_org_token"
}

{
  "requestType":"getAllOrganizations",
  "userKey": "user_key", 
  "globalOrgToken":"global_organization_token"
}

{
    "organizations": [
        {
            "orgName": "Org A",
            "orgToken": "Org_a_token"
        },
        {
            "orgName": "Org B",
            "orgToken": "Org_b_token"
        }
    ],
    "message": "Success"
}

{
	"requestType": "getProductTags",
    "userKey": "user_key", 
	"productToken": productToken
}

{
	"productTags":[
    	{
			"name": "My Product A",
			"token": "product_token",
			"tags": {
                "newKey": [
                    "newValue",
                    "newValue2"
                ],
                "tagKeyA": [
                    "tagValueA"
                ]
            }
        }
    ]

{
"requestType": "saveProductTag",
"userKey": "user_key", 
"productToken": "productToken",
"tagKey": "newKey",
"tagValue": "newValue"
}

{
    "productTagsInfo": {
        "name": "productA",
        "token": {productToken},  
        "tags": {
            "newKey": "newValue"
        }
    }
}

{
"requestType": "getOrganizationProductTags",
"userKey": "user_key", 
"orgToken": "orgToken"
}

{
    "productTags": [
        {
            "name": "productA",
            "token": " productAToken",
            "tags": {
                "newKey": [
                    "newValue",
                    "newValue2"
                ],
                "tagKeyA": [
                    "tagValueA"
                ]
            }
        },
        {
            "name": " productB",
            "token": " productBToken",
            "tags": {}
        }
    ]
}

{
	"requestType" : "removeProductTag",
     "userKey": "user_key", 
	"productToken" : "product_token",
    "tagKey": "newKey",
    "tagValue": "newValue"
}

{
    "message": "Successfully removed product tag"
}

{
	"requestType" : "getOrganizationProjectTags",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductProjectTags",
    "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectTags",
    "userKey": "user_key", 
	"projectToken" : "project_token"
}

{
	"projectTags":[
    	{
			"name": "My Project 1",
			"token": "project_token_1",
			"tags":{
				"Component": "Database",
				"Module": "Server"
			}
		},
		{
			"name": "My Project 2",
			"token": "project_token_2",
			"tags":{}
		}
	]
}

{
    "requestType" : "saveProjectTag",
     "userKey": "user_key", 
    "projectToken" : "project_token", 
    "tagKey":"key1",
    "tagValue":"value1"
}

{
	"projectTags":
		{
			"name": "My Project 1",
			"token": "project_token_1",
			"tags":
				{
					"key1": "value1"
				}
		}
}

{
	"requestType" : "getLicensesTextZip",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
    "requestType" : "getProjectLicensesTextZip",
     "userKey": "user_key",
    "projectToken" : "project_token"
}

The response is a zip file, not a json formatted message

{
	"requestType" : "getCopyrightsTextFile",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
    "requestType" : "getProjectCopyrightsTextFile",
     "userKey": "user_key",
    "projectToken" : "project_token"
}

{  
  "requestType": "setLibraryNotice",  
  "orgToken" : "org_token", 
  "userKey": "user_key",  
  "libraryUUID": "library_UUID", 
  "text": "Notices are fun!", 
  "reference": "And references are too"
}

{
    "message": "Successfully set notice"
}

This request is available only for products

{
	"requestType" : "getNoticesTextFile",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

This request is available for organizations or products

{
	"requestType" : "getOrganizationRiskReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductRiskReport",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectRiskReport",
     "userKey": "user_key", 
	"projectToken" : "project_token"
}

This request is available for organizations, products or projects.
An xlsx format is used when no format is provided.

{
	"requestType" : "getOrganizationInventoryReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key",
	"format" : "json" 
}

{
	"requestType" : "getProductInventoryReport",
     "userKey": "user_key", 
	"productToken" : "product_token",
    "format" : "xlsx" 
}

{
	"requestType" : "getProjectInventoryReport",
     "userKey": "user_key", 
	"projectToken" : "project_token",
	"format" : "xlsx" 
}

{
    "userKey": "user_key",
    "orgToken": "organization_api_key",
	"requestType":"getChangeLogHistoryReport"	
}

This request is available for organizations, products or projects. An 'xlsx' format is used when no 'format' parameter is provided.

{
	"requestType" : "getOrganizationVulnerabilityReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
	"format" : "xlsx"
}

{
	"requestType" : "getProductVulnerabilityReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"format" : "xlsx"
}

{
	"requestType" : "getProjectVulnerabilityReport",
     "userKey": "user_key", 
	"projectToken" : "project_token",
	"format" : "json"
}

This request is available for the organization and cluster level. An 'xlsx' format is used when no 'format' parameter is provided.

{
    "requestType" : "getOrganizationContainerVulnerabilityReport",
     "userKey": "user_key", 
    "orgToken" : "org_token",
    "format" : "xlsx"
}

{
    "requestType" : "getClusterVulnerabilityReport",
     "userKey": "user_key", 
    "productToken" : "product_token",
    "format" : "json"
}

This request is available for organizations, products or projects.
An xlsx format is used when no format is provided.

{
	"requestType" : "getOrganizationSourceFileInventoryReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
	"format" : "json" 
}

{
	"requestType" : "getProductSourceFileInventoryReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"format" : "json" 
}

{
	"requestType" : "getProjectSourceFileInventoryReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
	"format" : "xlsx" 
}

This request is available for organizations, products or projects. An 'xlsx' format is used when no 'format' parameter is provided.

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getOrganizationAlertsReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
	"format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProductAlertsReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProjectAlertsReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
	"format" : "xlsx"
}

This request is available for organizations or products

{
	"requestType" : "getOrganizationAttributesReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductAttributesReport",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
  "requestType":"getOrganizationCustomAttributeValues",
   "userKey": "user_key", 
  "orgToken": "<orgToken>",  // For example, orgToken for "ACME Corporation"
  "userKey": "<userKey>"
}

"customAttributeValues": [ 
  { 
    "<keyUuid>": [ 
        { 
          "organizationAttr0": "value0", 
          "context": "Organizational",
          "contextId": 2133534,
          "contextToken": "4534fgdfjghj5456jlklsdf7",
          "contextName": "ACME Corporation" 
        } 
    ] 
  }, 
  { 
    "<keyUuid>": [ 
       { 
         "organizationAttr0": "valueX", 
         "context": "Organizational",
         "contextId": 2133534,
         "contextToken": "4534j5456jlklsdf7",
         "contextName": "ACME Corporation" 
       }, 
       { 
         "productAttr1": "valueA", 
         "context": "Product",
         "contextId": 989795,
         "contextToken": "isdfsdfkhosdf935pokwt",
         "contextName": "Product A"
         
       }, 
       { 
         "productAttr1": "valueB", 
         "context": "Product",
         "contextId": 07435365,
         "contextToken": "llsfi4trerg90824sdf",
         "contextName": "Product B" 
       }, 
       { 
         "projectAtt2": "value", 
         "context": "Project",
         "contextId": 985743395,
         "contextToken": "ldshwufnvf9235jgdg0",
         "contextName": "Project A" 
       }, 
       { 
         "projectAtt2": "value", 
         "context": "Project",
         "contextId": 098345345,
         "contextToken": "klasd309438dflkl0934t",
         "contextName": "Project B" 
       } 
    ] 
  } 
] 

{
  "requestType":"getProductCustomAttributeValues",
   "userKey": "user_key", 
  "productToken": "<productToken>", // For example, productToken for "Product A"
  "userKey": "<userKey>"
}

"customAttributeValues": [ 
  { 
    "<keyUuid>": [ 
        { 
          "organizationAttr0": "value0", 
          "context": "Organizational",
          "contextId": 2133534,
          "contextToken": "45345345fdg5456jlklsdf7",
          "contextName": "ACME Corporation"
        } 
    ] 
  }, 
  { 
    "<keyUuid>": [ 
       { 
         "organizationAttr0": "valueX", 
         "context": "Organizational",
         "contextId": 2133534,
         "contextToken": "45345345fdgdfgdfjghjlsdf7",
         "contextName": "ACME Corporation"
       }, 
       { 
         "productAttr1": "valueA", 
         "context": "Product",
         "contextId": 989795,
         "contextToken": "isdfsdfkh3086h35pokwt",
         "contextName": "Product A"
       }, 
       { 
         "projectAtt2": "value", 
         "context": "Project",
         "contextId": 985743395,
         "contextToken": "ldshwufnvo59332hf9gdg0",
         "contextName": "Project A" 
       }, 
       { 
         "projectAtt2": "value", 
         "context": "Project",
         "contextId": 098345345,
         "contextToken": "klasd309438dflkjg94t0934t",
         "contextName": "Project B" 
       } 
    ] 
  } 
] 

{
  "requestType":"getProjectCustomAttributeValues",
   "userKey": "user_key", 
  "projectToken": "<projectToken>",   // For example, projectToken for "Project A" that belongs to "Product A"
  "userKey": "<userKey>"
}

"customAttributeValues": [ 
  { 
    "<keyUuid>": [ 
        { 
          "organizationAttr0": "value0", 
          "context": "Organizational",
          "contextId": 2133534,
          "contextToken": "45345345fdgdfgd456jlklsdf7",
          "contextValue": "ACME Corporation"
        } 
    ] 
  }, 
  { 
    "<keyUuid>": [ 
       { 
         "organizationAttr0": "valueX", 
         "context": "Organizational",
         "contextId": 2133534,
         "contextToken": "45345345fdgdfgdfjghjlklsdf7",
         "contextName": "ACME Corporation"
       }, 
       { 
         "productAttr1": "valueA", 
         "context": "Product",
         "contextId": 989795,
         "contextToken": "isdfsdfkh30osdf935pokwt",
         "contextName": "Product A" 
       }, 
       { 
         "projectAtt2": "value", 
         "context": "Project",
         "contextId": 985743395,
         "contextToken": "ldshwufnvo59332hfjgdg0",
         "contextName": "Project A" 
       }
    ] 
  } 
] 

This request is available for organizations or products

{
	"requestType" : "getOrganizationLibraryLocationReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductLibraryLocationReport",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

This request is available for organizations, products or projects.
An xlsx format is used when no format is provided.

{
	"requestType" : "getOrganizationDueDiligenceReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key",
	"format" : "xlsx" 
}

{
	"requestType" : "getProductDueDiligenceReport",
     "userKey": "user_key", 
	"productToken" : "product_token",
	"format" : "json" 
}

{
	"requestType" : "getProjectDueDiligenceReport",
     "userKey": "user_key", 
	"projectToken" : "project_token",
	"format" : "json" 
}

This request is available for organizations or products

{
	"requestType" : "getOrganizationEffectiveLicensesReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductEffectiveLicensesReport",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

This request is available for organizations, products or projects

{
	"requestType" : "getOrganizationBugsReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductBugsReport",
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectBugsReport",
     "userKey": "user_key", 
	"projectToken" : "project_token"
}

This request is available for organizations, products or projects.

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getOrganizationIgnoredAlertsReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProductIgnoredAlertsReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
    "format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProjectIgnoredAlertsReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
    "format" : "xlsx"
}

This request is available for organizations, products or projects

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getOrganizationResolvedAlertsReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProductResolvedAlertsReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
    "format" : "xlsx"
}

For customers who have enabled Security Alerts: View By Vulnerability, this API will not be available.

{
	"requestType" : "getProjectResolvedAlertsReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
    "format" : "xlsx"
}

The requests are available for products or projects

{
	"requestType": "getProductAttributionReport",
	"productToken" : "product_token",
	"userKey": "user_key",
	"reportHeader":	"header_text", // Default "Attribution Report"
	"reportTitle": "title_text", // Default ""
	"reportFooter": "footer_text", // Default ""
	"reportingScope": ( SUMMARY | LICENSES | COPYRIGHTS | NOTICES | PRIMARY_ATTRIBUTES), // Default all options (SUMMARY, LICENSES, COPYRIGHTS, NOTICES, PRIMARY_ATTRIBUTES)
	"reportingAggregationMode": ( BY_COMPONENT | BY_PROJECT ), // Mandatory
	"missingLicenseDisplayOption": ( BLANK | GENERIC_LICENSE ), // Default "BLANK"
	"exportFormat": ( TXT | HTML | JSON ), // Case insensitive
	"licenseReferenceTextPlacement": ( LICENSE_SECTION | APPENDIX_SECTION ), // Default "LICENSE_SECTION"
	"customAttribute": "custom_attribute_name",
    "includeVersions": "false" // Optional parameter, default value is "true". If set to "false", the attribution report will not include the field "version".
}

{
	"requestType": "getProjectAttributionReport",
	"projectToken" : "project_token",
	"userKey": "user_key",
	"reportHeader":	"header_text", // Default "Attribution Report"
	"reportTitle": "title_text", // Default ""
	"reportFooter": "footer_text", // Default ""
	"reportingScope": ( SUMMARY | LICENSES | COPYRIGHTS | NOTICES | PRIMARY_ATTRIBUTES ), // Default all options (SUMMARY, LICENSES, COPYRIGHTS, NOTICES, PRIMARY_ATTRIBUTES)
	"reportingAggregationMode": ( BY_COMPONENT | BY_PROJECT ), // Mandatory
	"missingLicenseDisplayOption": ( BLANK | GENERIC_LICENSE ), // Default "BLANK"
	"exportFormat": ( TXT | HTML | JSON ), // Case insensitive
	"licenseReferenceTextPlacement": ( LICENSE_SECTION | APPENDIX_SECTION ), // Default "LICENSE_SECTION"
	"customAttribute": "custom_attribute_name",
    "includeVersions": "true" // Optional parameter, default value is "true". If set to "false", the attribution report will not include the field "version".
}

This request is available for organizations, products or projects

{
	"requestType" : "getOrganizationRequestHistoryReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductRequestHistoryReport",
    "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectRequestHistoryReport",
     "userKey": "user_key", 
	"projectToken" : "project_token"
}

This request is available for organizations, products or projects

{
	"requestType" : "getOrganizationMembersReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

{
	"requestType" : "getProductMembersReport",
     "userKey": "user_key", 
	"productToken" : "product_token"
}

{
	"requestType" : "getProjectMembersReport",
     "userKey": "user_key", 
	"projectToken" : "project_token"
}

This request is available for organizations

{
	"requestType" : "getPluginRequestHistoryReport",
     "userKey": "user_key", 
	"orgToken" : "organization_api_key"
}

This request is available for use with 2 products

{
	"requestType" : "getProductComparisonReport",
     "userKey": "user_key", 
	"productToken" : "product_token",
	"productToken2" : "product_token2"
}

This request is available for use with 2 projects

{
	"requestType" : "getProjectComparisonReport",
     "userKey": "user_key", 
	"projectToken" : "project_token",
	"projectToken2" : "project_token2"
}

{
    "requestType" : "getOrganizationInHouseReport",
    "orgToken" : "organization_api_key",
    "userKey": "user_key"
}

{
    "requestType" : "getProductInHouseReport",
    "productToken" : "product_token",
    "userKey": "user_key"
}

{
    "requestType" : "getProjectInHouseReport",
    "projectToken" : "project_token",
    "userKey": "user_key"
}

{
    "requestType" : "getProductLicenseCompatibilityReport",
    "productToken" : "product_token",
    "userKey": "user_key"
}

{
    "requestType" : "getProjectLicenseCompatibilityReport",
    "projectToken" : "project_token",
    "userKey": "user_key"
}

{
	"requestType" : "getProductLibraryLocations",
     "userKey": "user_key", 
	"projectToken" : "project_token"	
}

"libraryLocations" : [
	{
		"name" : "library_name",
		"keyId" : key_id,
		"keyUuid" : "key_uuid",
		"locations": [
			{
				"path" : "library_location_1\library_name",
				"matchType": "SHA1"
			},
			{
				"path": "library_location_2\\library_name",
				"matchType": "FILENAME"
			}
		]
	}
]

{
	"requestType" : "getProjectLibraryLocations",
     "userKey": "user_key", 
	"projectToken" : "project_token"	
}

"libraryLocations" : [
	{
		"name" : "library_name",
		"keyId" : key_id,
		"keyUuid" : "key_uuid",
		"locations": [
			{
				"path" : "library_location_1\library_name",
				"dependencyFile" : "home/ubuntu/GiHubRepos/Samples123/pom.xml"	
				"matchType": "SHA1"
			},
			{
				"path": "library_location_2\\library_name",
				"dependencyFile" : "home/ubuntu/GiHubRepos/Samples234/pom.xml"	
				"matchType": "FILENAME"
			}
		]
	}
]

{
  "requestType": "createGroup",
  "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "group":{
  "name":"group_name",
  "description":"group_description"
	}
}

{
"group":{
"id": 8340,
"name": "test_group",
"description": "best group ever",
"users":[]
},
"message": "Successfully created group test_group"
}

The following API request must be executed by Organization Administrators only.

{
  "requestType": "createUser",
   "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "inviter":{
    "email": "inviter_email"
  	},
  "addedUser":{
    "name":"new_user_name",
    "email":"new_user_email"
  	}
}

"message":"Successfully created user new_user_name"

The following API request must be executed by Organization Administrators only.

{
  "requestType": "inviteUsers",
   "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "inviter":{
    "email":"inviter_email"
  },
  "emails":[
    "new_email1",
    "new_email2"
  ]
}

"message":"Successfully sent invitation to new_email1,new_email2"

The following API request must be executed by Organization Administrators only.

{
  "requestType": "getAllGroups",
   "userKey": "user_key", 
  "orgToken": "organization_api_key"
}

{
"groups":[
{
"id": 2373,
"name": "admins",
"description": "Alex playground administrators",
"users":[
{"id": 2458, "email": "john1@gmail.com", "name": "John2"},
{"id": 1841, "email": "john2@gmail.com", "name": "John1"}
]}],
"message":"Organization groups"
}

The following API request must be executed by Organization Administrators only.

{
  "requestType": "getAllUsers",
   "userKey": "user_key", 
  "orgToken": "organization_api_key"
}

{
"users":[
{
"id": 1841,
"email": "john@gmail.com",
"name": "John Doe"
}],
"message":"Organization users"
}

The following API request must be executed by Organization Administrators only.

{
  "requestType": "addUsersToGroups",
   "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "assignedUsers" :
  [
    [{"name":"group_name"},[{"email":"assigned_user_email"},
							{"email":"assigned_user_email"}]]
  ]
}

"message":"Successfully assigned users to groups"

The following API request must be executed by Organization Administrators only.

"message":"Successfully removed user from group"

The following API request must be executed by Organization Administrators only.

{
  "requestType": "removeUserFromOrganization",
   "userKey": "user_key", 
  "orgToken":"your_org_token",
  "user": { "email": "user_email" }
}

"message":"Successfully removed user from organization"

{
    "requestType":"getOrganizationAssignments",
     "userKey": "user_key", 
    "orgToken":"organization_api_key"
}

{
   "groupRoles":{
      "USER":[
         {
            "id":group_id,
            "name":"users",
            "description":"All users in organization",
            "users":[
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"No Name"
               },
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"user_name"
               }
            ]
         }
      ],
      "ADMIN":[
         {
            "id":group_id,
            "name":"admins",
            "description":"Administrators",
            "users":[
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"user_name"
               }
            ]
         }
      ]
   },
   "userRoles":{
      "USER":[
         {
            "id":user_id,
            "email":"user_email",
            "name":"user_name"
         },
         {
            "id":user_id,
            "email":"user_email",
            "name":"user_name"
         }
      ],
      "DEFAULT_APPROVER":[
         {
            "id":user_id,
            "email":"user_email",
            "name":"user_name"
         }
      ]
   }
}

{
    "requestType":"getProductAssignments",
     "userKey": "user_key", 
    "productToken":"product_api_key"
}

{
   "groupRoles":{
      "ALERT_EMAIL_RECEIVER":[
         {
            "id":group_id,
            "name":"group_name",
            "description":"Email receivers",
            "users":[
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"user_name"
               }
            ]
         }
      ],
      "ADMIN":[
         {
            "id":group_id,
            "name":"group_name",
            "description":"Administrators",
            "users":[
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"user_name"
               }
            ]
         }
      ],
       "PRODUCT_INTEGRATOR":[
         {
            "id":group_id,
            "name":"group_name",
            "description":"Product Integrators",
            "users":[
               {
                  "id":user_id,
                  "email":"user_email",
                  "name":"user_name"
               }
            ]
         }
      ]
   },
   "userRoles":{
   }
}

{
  "requestType": "setOrganizationAssignments",
   "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "administrators" :
  {
    "groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
	"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
  }
}

"message":"Successfully set organization assignments"

{
  "requestType": "setOrganizationAssignments",
  "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "alertsEmailReceivers" :
  {
    "groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
	"userAssignments":[{"email":"user_email"},{"email":"user_email"}]
  }
}

"message":"Successfully set organization assignments"

{
  "requestType": "setOrganizationAssignments",
  "userKey": "user_key", 
  "orgToken": "organization_api_key",
  "defaultApprover" :
  {
     "groupAssignments":[{"name":"group_name"},{"name":"group_name"}],
	 "userAssignments":[{"email":"user_email"},{"email":"user_email"}]
  }
}

"message":"Successfully set organization assignments"

{
    "requestType" : "setOrganizationAssignments",
    "userKey":"admin_user_key"
    "orgToken" : "organization_api_key",
    "readOnlyUsers" :
	{
       "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], // This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single user.
	   "userAssignments":[{"email":"user_email"},{"email":"user_email"}],  //This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single group.
	   "groupAssignment":{"name":"group_name"},{"name":"group_name"},
	   "userAssignment":{"email":"user_email"},{"email":"user_email"}
    }
}

"message": "The following organization assignments have been set: Read Only"

{
  "requestType": "setProductAssignments",
   "userKey": "user_key", 
  "productToken": "product_api_key",
  "productAdmins" :
  {
    "userAssignments":[{"email":"user_email"}],
    "groupAssignments":[{"name":"group_name"}]
  }
}

"message":"Successfully set product assignments"

{
  "requestType": "setProductAssignments",
  "userKey": "user_key", 
  "productToken": "product_api_key",
  "alertsEmailReceivers" :
  {
    "userAssignments":[{"email":"user_email"}],
    "groupAssignments":[{"name":"group_name"}]
  }
}

"message":"Successfully set product assignments"

{
  "requestType": "setProductAssignments",
  "userKey": "user_key", 
  "productToken": "product_api_key",
  "productMembership" :
  {
    "userAssignments":[{"email":"user_email"}],
    "groupAssignments":[{"name":"group_name"}]
  }
}

"message":"Successfully set product assignments"

{
  "requestType": "setProductAssignments",
   "userKey": "user_key", 
  "productToken": "product_api_key",
  "productApprovers" :
  {
    "userAssignments":[{"email":"user_email"}],
    "groupAssignments":[{"name":"group_name"}]
  }
}

"message":"Successfully set product assignments"

{
  "requestType": "setProductAssignments",
   "userKey": "user_key", 
  "productToken": "product_api_key",
  "productIntegrators" :
  {
    "userAssignments":[{"email":"user_email"}], // This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single user.
    "groupAssignments":[{"name":"group_name"}], //This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single group.
    "userAssignment":{"email":"user_email"}, 
    "groupAssignment":{"name":"group_name"}
  }
}

"message":"Successfully set product assignments"

{
    "requestType" : "createProject",
     "userKey": "user_key", 
    "productToken": "product_token",
    "projectName": "my new project",
    "projectDescription" : "optional field. Not mandatory"
}

The "projectDescription" field is an optional field.

{
  "projectToken": "new project token here",
  "message": "Successfully created project my new project"
}

{
"requestType" : "deleteProject",
 "userKey": "user_key", 
"productToken" : "parent product token",
"projectToken": "token of the project to be deleted"
}

{
"message": "Successfully deleted project <project name>"
}

{
"requestType" : "createProduct",
 "userKey": "user_key", 
"productName" : "new product name",
"orgToken" : "organization token"
}

{
"productToken": "new product token",
"message": "Successfully created product <new product name>"
}

{
"requestType" : "deleteProduct",
 "userKey": "user_key", 
"orgToken" : "organization token",
"productToken" :"product token"
}

{
"message": "Successfully deleted product <product name>"
}

'includeInHouseData' is an optional parameter. When set to ‘false’, in-house libraries data is not returned in the API response (default is ‘true’).

{
"requestType" : "getProjectHierarchy",
 "userKey": "user_key", 
"projectToken" : "project token",
"includeInHouseData" : true
}

{
  "libraries": [
    {
      "keyUuid": "1f9ee6ec-eded-45d3-8fdb-2d0d735e5b14",
      "keyId": 43,
      "filename": "log4j-1.2.17.jar",
      "name": "log4j",
      "groupId": "log4j",
      "artifactId": "log4j",
      "version": "1.2.17",
      "sha1": "5af35056b4d257e4b64b9e8069c0746e8b08629f",
      "type": "UNKNOWN_ARTIFACT",
      "coordinates": "log4j:log4j:1.2.17"
    },
    {
      "keyUuid": "f362c53f-ce25-4d0c-b53b-ee2768b32d1a",
      "keyId": 45,
      "filename": "akka-actor_2.11-2.5.2.jar",
      "name": "akka-actor",
      "groupId": "com.typesafe.akka",
      "artifactId": "akka-actor_2.11",
      "version": "2.5.2",
      "sha1": "183ccaed9002bfa10628a5df48e7bac6f1c03f7b",
      "type": "MAVEN_ARTIFACT",
      "coordinates": "com.typesafe.akka:akka-actor_2.11:2.5.2",
      "dependencies": [
        {
          "keyUuid": "49c6840d-bf96-470f-8892-6c2a536c91eb",
          "keyId": 44,
          "filename": "scala-library-2.11.11.jar",
          "name": "Scala Library",
          "groupId": "org.scala-lang",
          "artifactId": "scala-library",
          "version": "2.11.11",
          "sha1": "e283d2b7fde6504f6a86458b1f6af465353907cc",
          "type": "MAVEN_ARTIFACT",
          "coordinates": "org.scala-lang:scala-library:2.11.11"
        },
        {
          "keyUuid": "e5e730d1-8b41-4d2d-a8c5-610a374b6501",
          "keyId": 46,
          "filename": "scala-java8-compat_2.11-0.7.0.jar",inve
          "name": "scala-java8-compat_2.11",
          "groupId": "org.scala-lang.modules",
          "artifactId": "scala-java8-compat_2.11",
          "version": "0.7.0",
          "sha1": "a31b1b36bcf0d53657733b5d40c78d5f090a5dea",
          "type": "UNKNOWN_ARTIFACT",
          "coordinates": "org.scala-lang.modules:scala-java8-compat_2.11:0.7.0"
        },
        {
          "keyUuid": "426c0056-f180-4cac-a9dd-c266a76b32c9",
          "keyId": 47,
          "filename": "config-1.3.1.jar",
          "name": "config",
          "groupId": "com.typesafe",
          "artifactId": "config",
          "version": "1.3.1",
          "sha1": "2cf7a6cc79732e3bdf1647d7404279900ca63eb0",
          "type": "UNKNOWN_ARTIFACT",
          "coordinates": "com.typesafe:config:1.3.1"
        }
      ]
    },
    {
      "keyUuid": "25a8ceaa-4548-4fe4-9819-8658b8cbe9aa",
      "keyId": 48,
      "filename": "kafka-clients-0.10.2.1.jar",
      "name": "Apache Kafka",
      "groupId": "org.apache.kafka",
      "artifactId": "kafka-clients",
      "version": "0.10.2.1",
      "sha1": "3dd2aa4c9f87ac54175d017bcb63b4bb5dca63dd",
      "type": "MAVEN_ARTIFACT",
      "coordinates": "org.apache.kafka:kafka-clients:0.10.2.1",
      "dependencies": [
        {
          "keyUuid": "71065ffb-e509-4e2d-88bc-9184bc50888d",
          "keyId": 49,
          "filename": "lz4-1.3.0.jar",
          "name": "LZ4 and xxHash",
          "groupId": "net.jpountz.lz4",
          "artifactId": "lz4",
          "version": "1.3.0",
          "sha1": "c708bb2590c0652a642236ef45d9f99ff842a2ce",
          "type": "MAVEN_ARTIFACT",
          "coordinates": "net.jpountz.lz4:lz4:1.3.0"
        },
        {
          "keyUuid": "e44ab569-de95-4562-8efa-a2ebfe808471",
          "keyId": 50,
          "filename": "slf4j-api-1.7.21.jar",
          "name": "SLF4J API Module",
          "groupId": "org.slf4j",
          "artifactId": "slf4j-api",
          "version": "1.7.21",
          "sha1": "139535a69a4239db087de9bab0bee568bf8e0b70",
          "type": "MAVEN_ARTIFACT",
          "coordinates": "org.slf4j:slf4j-api:1.7.21"
        },
        {
          "keyUuid": "72ecad5e-9f35-466c-9ed8-0974e7ce4e29",
          "keyId": 51,
          "filename": "snappy-java-1.1.2.6.jar",
          "name": "snappy-java",
          "groupId": "org.xerial.snappy",
          "artifactId": "snappy-java",
          "version": "1.1.2.6",
          "sha1": "48d92871ca286a47f230feb375f0bbffa83b85f6",
          "type": "UNKNOWN_ARTIFACT",
          "coordinates": "org.xerial.snappy:snappy-java:1.1.2.6"
        }
      ]
    }
  ]
}

'includeInHouseData' is an optional parameter. When set to ‘false’, in-house libraries data is not returned in the API response (default is ‘true’).

{
"requestType" : "getProjectInventory",
 "userKey": "user_key", 
"projectToken" : "project_token",
"includeInHouseData" : true
}

{"projectVitals":{
"productName": "fsa",
"name": "fsa",
"token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"creationDate": "2017-06-17 07:12:29",
"lastUpdatedDate": "2017-06-17 07:34:31"
},
"libraries":[
{
"keyUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"keyId": 24559109,
"name": "comm-2.0.3.jar",
"artifactId": "comm-2.0.3.jar",
"type": "MAVEN_ARTIFACT",
"licenses":[],
"vulnerabilities":[],
"outdated": false,
"matchType": "FILENAME"
}]}

{
    "requestType":"getProjectState",
     "userKey": "user_key", 
  	"projectToken":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

{
	"projectState":{
	"lastProcess":"UPDATE",
	"inProgress":false,
	"date":"2017-06-17"}
}

{
    "requestType":"getLibrarySourceFiles",
     "userKey": "user_key", 
  	"projectToken":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "keyUuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

{"sourceFiles":[{
	"sha1":"6bf3b8ddfecac64a916ba69de50e9faac70992ba",
	"name":"x509_obj.c",
	"path":"C:\\Users\\Work1\\Documents\\FSA\\GITHUB-downloads\\openssl_openssl_OpenSSL_0_9_4_openssl_openssl_OpenSSL_0_9_4_crypto_x509_x509_obj.c"}]
}

{
  "requestType":"getProjectLibraryDependencies",
  "userKey": "user_key", 
  "projectToken":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "keyUuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

{
   "dependencies":[
     [
      {
         "keyUuid":"0b6a3818-ed95-4190-b40d-0d0d9ca51166",
         "name":"CDI APIs",
         "groupId":"javax.enterprise",
         "artifactId":"cdi-api",
         "version":"1.0",
         "classifier":"",
         "scope":"COMPILE",
         "extension":"jar",
         "sha1":"44c453f60909dfc223552ace63e05c694215156b",
         "dependencies":[
            {
               "keyUuid":"e8d725f6-081c-4e7d-b09c-3fadcb861a35",
               "name":"JSR-250 Common Annotations for the JavaTM Platform",
               "groupId":"javax.annotation",
               "artifactId":"jsr250-api",
               "version":"1.0",
               "classifier":"",
               "scope":"COMPILE",
               "extension":"jar",
               "sha1":"5025422767732a1ab45d93abfea846513d742dcf",
               "dependencies":[
               ],
               "licenses":[
                  {
                     "name":"CDDL 1.0",
                     "url":"http://www.opensource.org/licenses/CDDL-1.0"
                  }
               ]
            }
         ],
         "licenses":[
            {
               "name":"Apache 2.0",
               "url":"http://www.opensource.org/licenses/Apache-2.0"
            }
         ]
      },
      {
         "keyUuid":"b4264d26-09ca-4266-97ba-0bec7318d984",
         "name":"org.eclipse.sisu.inject",
         "groupId":"org.eclipse.sisu",
         "artifactId":"org.eclipse.sisu.inject",
         "version":"0.3.2",
         "classifier":"",
         "scope":"COMPILE",
         "extension":"jar",
         "sha1":"59044b92ec27cc6fda7a2d24b2cd6cec23f31d5b",
         "dependencies":[
         ],
         "licenses":[
            {
               "name":"Eclipse 1.0",
               "url":"http://www.opensource.org/licenses/EPL-1.0"
            }
         ]
      }
    ]
  ]
}

{
  "requestType" : "inviteUserToWebAdvisor",
   "userKey": "user_key", 
  "orgToken" : "Organization Token",
  "userEmail": "User email address"
}

{ "message": "Successfully invited external user" }

{
  "requestType": "createServiceUser",
  "orgToken": "organization_api_key",
  "userKey": "user_key",
  "addedUser":{
    "name":"new_user_name"
    }
}

{
    "user" : {
        "userKey":  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
}

{
  "requestType": "regenerateUserKey",
  "orgToken": "organization_api_key",
   "userKey": "user_key",
   "serviceUserKey": "service_user_key"
}

{
    "user" : {
        "userKey":  232gkey45gt34
}

{
  "requestType":"getOrganizationServiceUsers",
  "userKey":"user_key",
  "orgToken":"org_token"
}

{
    "serviceUsers": [
        {
            "serviceUserName": "user_a",
            "serviceUserToken": "user_a_token"
        },
        {
            "serviceUserName": "user_b",
            "serviceUserToken": "user_b_token"
        }
    ]
}

{
  "requestType":"getProductServiceUsers",
  "userKey":"user_key",
  "productToken":"product_token"
}

{
    "serviceUsers": [
        {
            "serviceUserName": "user_a",
            "serviceUserToken": "user_a_token"
        }
    ]
}

{
    "requestType" : "changeOriginLibrary",
    "userKey": "userKey",
    "orgToken" : "orgToken",
    "targetKeyUuid": "key-uuid-of-the-source-library-to-change-files",
    "sourceFiles": ["sha1_1", "sha1_2"],
    "userComments": "user-comments"
}

{
    "message": "Successfully changed origin library"
}

{ 
  "requestType" : "setProjectSetupNotificationConfig", 
  "orgToken" : "organization_api_key", 
  "userKey" : "user_api_key", 
  "action": "notification_ENABLED|DISABLED|CUSTOM", 
  "projectTagKeyRegex" : "project_tag_key_pattern", 
  "projectTagValueRegex" : "project_tag_value_pattern" 
}

{ 
"message": "Successfully changed project setup completion notification configuration" 
}

{ 
  "requestType" : "setProjectSetupNotificationConfig", 
  "orgToken" : "5dc3e478a8f6500e5b525f3", 
  "userKey" : "7e3694ac0a50ebb", 
  "action": "CUSTOM", 
  "projectTagKeyRegex" : "^[0-9]*$", 
  "projectTagValueRegex" : "^(ProjectTagValue)"
}

{
    "requestType" : "getRequestState",
    "userKey": "user_key", 
    "orgToken" : "organization token",
    "requestToken" : "support token"
}

{
    "requestState": "FINISHED",
    "timestamp": "2018-02-28T17:48:19Z"
}

The following APIs are only available in organization set to vulnerability based alerting mode. 

{
	"requestType" : "getOrganizationSecurityAlertsByVulnerabilityReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "status" : "active",
    "format" : "xlsx"
}

{
	"requestType" : "getProductSecurityAlertsByVulnerabilityReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"status" : "ignored",
    "format" : "xlsx"
}

{
	"requestType" : "getProjectSecurityAlertsByVulnerabilityReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
    "format" : "xlsx"
}

{
	"requestType" : "getOrganizationSecurityAlertsByLibraryReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "status" : "active",
    "format" : "xlsx"
}

{
	"requestType" : "getProductSecurityAlertsByLibraryReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"status" : "ignored",
    "format" : "xlsx"
}

{
	"requestType" : "getProjectSecurityAlertsByLibraryReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
    "format" : "xlsx"
}

{
	"requestType" : "getOrganizationLicenseAndComplianceAlertReport",
    "userKey": "user_key", 
	"orgToken" : "organization_api_key",
    "status" : "active",
    "format" : "xlsx"
}

{
	"requestType" : "getProductLicenseAndComplianceAlertReport",
    "userKey": "user_key", 
	"productToken" : "product_token",
	"status" : "ignored",
    "format" : "xlsx"
}

{
	"requestType" : "getProjectLicenseAndComplianceAlertReport",
    "userKey": "user_key", 
	"projectToken" : "project_token",
    "format" : "json"
}

The 'vulnerabilityFix' and 'fixResolutionText' fields are populated only when there is an available fix.