{"swagger":"2.0","info":{"version":"v3","title":"Fortify on Demand Web API Explorer"},"host":"api.ams.fortify.com","schemes":["https"],"paths":{"/api/v3/api-keys":{"get":{"tags":["ApiKeyManagement"],"summary":"Returns a list of API keys","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_GetApiKeys","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApiKeyListResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["ApiKeyManagement"],"summary":"Creates a new API key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_PostApiKey","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"PostApiKeyRequest model","required":true,"schema":{"$ref":"#/definitions/ApiKeyRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/api-keys/{apiKeyId}":{"get":{"tags":["ApiKeyManagement"],"summary":"Returns an API key","description":"Allowed Scopes: api-tenant,","operationId":"ApiKeyManagementV3_GetApiKey","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","description":"The Api Key id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApiKey"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["ApiKeyManagement"],"summary":"Updates an existing API key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_PutApiKey","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","description":"The Api Key id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostApiKeyRequest model","required":true,"schema":{"$ref":"#/definitions/ApiKeyRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["ApiKeyManagement"],"summary":"Deletes the given ApiKey","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_DeleteApiKey","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","description":"The api key id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/DeleteApiKeyResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/api-keys/{apiKeyId}/newsecret":{"post":{"tags":["ApiKeyManagement"],"summary":"Creates a new secret for an existing api key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_PostNewSecret","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","description":"The Api Key id","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/api-keys/{apiKeyId}/application-access":{"get":{"tags":["ApiKeyManagement"],"summary":"Returns a list of Applications assigned to an API Key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_GetAssignedApplicationsToApiKey","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","description":"Api Key Id","required":true,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApiKeyApplicationListResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["ApiKeyManagement"],"summary":"Assign applications to API Key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_ApplicationAccess","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/ApiKeyApplicationAccessRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/api-keys/{apiKeyId}/unassign-application-access":{"put":{"tags":["ApiKeyManagement"],"summary":"Unassign applications to API Key","description":"Allowed Scopes: api-tenant","operationId":"ApiKeyManagementV3_UnassignApplicationAccess","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiKeyId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/ApiKeyUnassignApplicationsRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ApiKeyResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}":{"get":{"tags":["Applications"],"summary":"Retrieves an individual application by id","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplication","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Application"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["Applications"],"summary":"Update an application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_PutApplication","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"The application data","required":true,"schema":{"$ref":"#/definitions/PutApplicationRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutApplicationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutApplicationResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutApplicationResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["Applications"],"summary":"Deletes an application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteApplicationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/DeleteApplicationResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications":{"get":{"tags":["Applications"],"summary":"Retrieve a collection of applications","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplications","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: applicationDescription, attributes","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"},{"name":"modifiedStartDate","in":"query","description":"The modified on or after date.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApplicationListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Applications"],"summary":"Create a new application and release","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_PostApplication","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"The application data","required":true,"schema":{"$ref":"#/definitions/PostApplicationRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostApplicationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/auto-report":{"get":{"tags":["Applications"],"summary":"Returns the associated auto-run report type for the application.","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetAutoReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetAutoReportResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Applications"],"summary":"Set-up the associated auto-run report for the application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_PostAutoReport","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"The auto report data","required":true,"schema":{"$ref":"#/definitions/PostAutoReportRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostAutoReportResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PostAutoReportResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/users":{"get":{"tags":["Applications"],"summary":"Returns a list of users that have access to the application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetApplicationUsersResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/user-groups":{"get":{"tags":["Applications"],"summary":"Returns a list of user groups that have access to the application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationUserGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetApplicationUserGroupsResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/owners":{"get":{"tags":["Applications"],"summary":"Returns a list of users that can be set as an application owner","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationOwners","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApplicationUserListResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/user-permissions":{"get":{"tags":["Applications"],"summary":"Returns the permissions the current user has for the application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationUserPermissions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApplicationUserPermissions"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/releases":{"get":{"tags":["Applications"],"summary":"Returns a list of releases for the given application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationReleases","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: suspended","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"},{"name":"modifiedStartDate","in":"query","description":"The modified on or after date.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReleaseListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/issue-count-by-severity":{"get":{"tags":["Applications"],"summary":"Retrieves number of issues by severity for an application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationIssueCount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApplicationIssueCountListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/scans":{"get":{"tags":["Applications"],"summary":"Returns a list of scans for the given application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetScansByApplicationId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ScanListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/bug-tracker":{"get":{"tags":["Applications"],"summary":"Returns the bug tracker settings for the given application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationBugTracker","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ApplicationBugTracker"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/microservices":{"get":{"tags":["Applications"],"summary":"Retrieves a list of Microservices for an application","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ApplicationsV3_GetApplicationMicroservices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"includeReleases","in":"query","description":"Value defaults to true if not specified.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MicroserviceListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Applications"],"summary":"Add a Microservice to an application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_PostApplicationMicroservice","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"The microservice data","required":true,"schema":{"$ref":"#/definitions/PostMicroserviceRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostMicroserviceResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/microservices/{microserviceId}":{"put":{"tags":["Applications"],"summary":"Edit a Microservice for an application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_PutApplicationMicroservice","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"microserviceId","in":"path","description":"The microservice id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"The microservice data","required":true,"schema":{"$ref":"#/definitions/PostMicroserviceRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostMicroserviceResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["Applications"],"summary":"Delete a Microservice for an application","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ApplicationsV3_DeleteApplicationMicroservice","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"microserviceId","in":"path","description":"The microservice id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostMicroserviceResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/audittemplates":{"get":{"tags":["Applications"],"summary":"Returns a list of audit templates for the given application","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"ApplicationsV3_GetAuditTemplates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"},{"name":"scanType","in":"query","description":"The scan type<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/AuditTemplateListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["Applications"],"summary":"Creates/Update Audit templates for the given application","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"ApplicationsV3_PutApplicationAuditTemplates","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"auditTemplatesRequest","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PutAuditTemplateFilterRequest"}}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/AuditTemplateResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/AuditTemplateResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/{applicationId}/vulnerabilities/{Id}":{"get":{"tags":["Applications"],"summary":"Returns a list of vulnerabilities with matching InstanceId","description":"Allowed Scopes: api-tenant, view-issues","operationId":"ApplicationsV3_GetVulnerabilityInstancesinApplicationByVulnerabilityId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The application Id","required":true,"type":"integer","format":"int32"},{"name":"Id","in":"path","description":"The Issue id","required":true,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value.\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2.\r\n<br /><br />Filtering is not supported for the following fields: auditPendingAuditorStatus, auditPendingSuppression, checkId, closedDate, closedStatus, falsePositiveChallenge, instanceId, pci1_2, sink, source, stig6, suppressedBy, timeToFixDays","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"},{"name":"includeFixed","in":"query","description":"Indicates if items that have been fixed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"includeSuppressed","in":"query","description":"Indicates if items that have been suppressed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"keywordSearch","in":"query","description":"Used for keyword searches","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetVulnerabilitiesResponseVulnerabilityDTOLight"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/attributes":{"get":{"tags":["Attributes"],"summary":"Retrieve a list of attributes","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"AttributesV3_GetAttribute","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: picklistValues","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/AttributeItemListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Attributes"],"summary":"Create a new attribute","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"AttributesV3_PostAttribute","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"The attribute data","required":true,"schema":{"$ref":"#/definitions/PostAttributeRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostAttributeResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/attributes/{attributeId}":{"put":{"tags":["Attributes"],"summary":"Update an attribute","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"AttributesV3_PutAttribute","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"attributeId","in":"path","description":"The attribute id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"The attribute data","required":true,"schema":{"$ref":"#/definitions/PutAttributeRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutAttributeResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutAttributeResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutAttributeResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["Attributes"],"summary":"Deletes an attribute","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"AttributesV3_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"attributeId","in":"path","description":"The attribute id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteApplicationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/DeleteApplicationResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/audittemplate/globalaudittemplates":{"get":{"tags":["AuditTemplate"],"summary":"Returns a list of global audit templates","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"AuditTemplateV3_GetGlobalAuditTemplates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanType","in":"query","description":"The scan type<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/AuditTemplateListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["AuditTemplate"],"summary":"Creates/Update Global Audit templates","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"AuditTemplateV3_PutGlobalAuditTemplates","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"auditTemplatesRequest","in":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PutAuditTemplateFilterRequest"}}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/AuditTemplateResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/AuditTemplateResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/scan-setup":{"get":{"tags":["DastAutomatedScans"],"summary":"Get Dast Automated scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DastAutomatedScansV3_GetDastAutomatedScanSetup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetDastAutomatedScanSetupResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/website-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated Website scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DastAutomatedScansV3_PutDastAutomatedWebsiteScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedWebsiteScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedWebsiteScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/workflow-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated Workflow scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DastAutomatedScansV3_PutDastAutomatedWorkflowScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedWorkflowScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedWorkflowScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/openapi-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated Open API scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DastAutomatedScansV3_PutDastAutomatedOpenApiScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedOpenApiScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedOpenApiScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/graphql-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated GraphQL scan setup details","operationId":"DastAutomatedScansV3_PutDastAutomatedGraphQlScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedGraphQLScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedGraphQLScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/grpc-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated GRPC scan setup details","operationId":"DastAutomatedScansV3_PutDastAutomatedGrpcScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedGrpcScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedGrpcScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/postman-scan-setup":{"put":{"tags":["DastAutomatedScans"],"summary":"Saves Dast Automated Postman scan setup details","operationId":"DastAutomatedScansV3_PutDastAutomatedPostmanScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDastAutomatedPostmanScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDastAutomatedPostmanScanSetupRequest"}}],"responses":{"200":{"description":"Ok"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponse"}},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/scan-setup/file-upload":{"patch":{"tags":["DastAutomatedScans"],"summary":"Uploads a Dast Automated file to release","operationId":"DastAutomatedScansV3_PatchDastAutomatedScanFileUpload","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID","required":true,"type":"integer","format":"int32"},{"name":"dastFileType","in":"query","description":"DAST Automated file type","required":true,"type":"string","enum":["OpenAPIDefinition","PostmanCollection","GraphQLDefinition","GRPCDefinition","WorkflowDrivenMacro","LoginMacro"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PatchDastAutomatedScanManifestResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dast-automated-scans/start-scan":{"post":{"tags":["DastAutomatedScans"],"summary":"Starts a DAST Automated scan using the current scan setup settings","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DastAutomatedScansV3_StartDastAutomatedScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release ID of the scan to start","required":true,"type":"integer","format":"int32"},{"name":"networkName","in":"query","description":"Network Name","required":false,"type":"string"},{"name":"fallbackToActiveEntitlement","in":"query","description":"Use existing active entitlement if specified entitlement is expired. Value defaults to true if not specified.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/StartDastAutomatedScanResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dynamic-scans/scan-setup":{"get":{"tags":["DynamicScans"],"summary":"Get dynamic scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DynamicScansV3_GetDynamicScanSetup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetDynamicScanSetupResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["DynamicScans"],"summary":"Saves dynamic scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DynamicScansV3_PutDynamicScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutDynamicScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutDynamicScanSetupRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutDynamicScanSetupResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutDynamicScanSetupResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutDynamicScanSetupResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dynamic-scans/scan-setup/manifest":{"patch":{"tags":["DynamicScans"],"summary":"Uploads a web service manifest to the release","operationId":"DynamicScansV3_PatchDynamicScanManifestSetup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"webServiceFileType","in":"query","description":"The web service type","required":true,"type":"string","enum":["Postman","OpenApi","GraphQL","Grpc","WSDL"]},{"name":"postmanFileType","in":"query","description":"Select a file type (Workflow, Auth, Environment, or Globals). \r\nWorkflow file is required. Defaults to Workflow if not specified.","required":false,"type":"string","enum":["Workflow","Auth","Environment","Globals"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PatchDynamicScanSetupManifestResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PatchDynamicScanSetupManifestResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PatchDynamicScanSetupManifestResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dynamic-scans/start-scan":{"post":{"tags":["DynamicScans"],"summary":"Starts a dynamic scan using the current scan setup settings","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DynamicScansV3_StartDynamicScan","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to start","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"Options for starting the scan","required":true,"schema":{"$ref":"#/definitions/StartDynamicScanRequest"}},{"name":"networkName","in":"query","description":"Network Name","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/StartDynamicScanResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/dynamic-scans/import-scan":{"put":{"tags":["DynamicScans"],"summary":"Saves the contents to import scan file","description":"Allowed Scopes: api-tenant, start-scans","operationId":"DynamicScansV3_PutImportScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to import","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"fileLength","in":"query","description":"The number of bytes of the file being imported","required":true,"type":"integer","format":"int64"},{"name":"importScanSessionId","in":"query","description":"The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutImportScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/dynamic-scans/dynamic-to-dast":{"put":{"tags":["DynamicScans"],"summary":"Switches Dynamic Scan Setup to Dast Automated","operationId":"DynamicScansV3_PutDynamicSetupDetailsToDastAutomated","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutDynamicToDastAutomatedResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/dynamic-scans/parse-totp-qr":{"post":{"tags":["DynamicScans"],"summary":"Parses a TOTP QR code image and extracts the TOTP secret.","operationId":"DynamicScansV3_ParseTotpQrCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"TOTP secret extracted","schema":{"$ref":"#/definitions/ParseTotpQrResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutDynamicScanSetupResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/eventlogs/download":{"get":{"tags":["EventLogs"],"summary":"Download the last 24 hours of event log data in csv format","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"EventLogsV3_Download","consumes":[],"produces":["application/x-download"],"responses":{"200":{"description":"Ok","schema":{"type":"file"}},"204":{"description":"NoContent"},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/fortify-on-demand-connect-networks":{"get":{"tags":["FortifyOnDemandConnectNetworks"],"summary":"Retrieve a list of Fortify on Demand Connect networks","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"FortifyOnDemandConnectNetworksV3_GetNetworks","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FortifyConnectApiNetworkListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/lookup-items":{"get":{"tags":["LookupItems"],"summary":"Returns a list of lookup items for the given type.","description":"Allowed Scopes: api-tenant, view-tenant-data\r\n            \r\nFor LanguageLevels, the group field indicates the TechnologyTypeId.","operationId":"LookupItemsV3_GetLookupItems","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"type","in":"query","description":"The type of lookup items to return","required":false,"type":"string","enum":["All","AnalysisStatusTypes","ApplicationTypes","ApiRoles","AssessmentTypes","AttributeDataTypes","AttributeTypes","AuditActionTypes","AuditPreferenceTypes","AuditTemplateConditionTypes","BusinessCriticalityTypes","ConcurrentRequestThreadsTypes","DataExportTypes","DayOfWeekTypes","DastAutomatedScanPolicies","DastAutomatedScanTypes","DynamicMobileScanTypeAuditTemplateFieldTypes","DynamicScanAuthenticationTypes","DynamicScanEnvironmentFacingTypes","DynamicScanWebServiceTypes","EntitlementFrequencyTypes","GeoLocations","LanguageLevels","MobileScanAuditPreferenceTypes","MobileScanEnvironmentTypes","MobileScanExternalDeviceTypes","MobileScanFrameworkTypes","MobileScanPlatformTypes","MobileScanRoleTypes","MultiFactorAuthorizationTypes","NetworkAuthenticationType","NotificationTriggerTypes","OpenSourceScanTypeAuditTemplateFieldTypes","PassFailReasonTypes","RepeatScheduleTypes","ReportFormats","ReportStatusTypes","ReportTemplateTypes","ReportTypes","Roles","ScanMethodTypes","ScanPreferenceTypes","ScanStatusTypes","ScanTypes","SDLCStatusTypes","StartScanMethodTypes","StaticScanTypeAuditTemplateFieldTypes","TechnologyTypes","TimeZones","TwoFactorInboxes","VulnerabilitySeverityTypes","SastScanPolicies"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/LookupItemListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/mobile-scans/scan-setup":{"get":{"tags":["MobileScans"],"summary":"Get mobile scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"MobileScansV3_GetMobileScanSetup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MobileScanSetup"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["MobileScans"],"summary":"Saves mobile scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"MobileScansV3_PutMobileScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutMobileScanRequest model","required":true,"schema":{"$ref":"#/definitions/PutMobileScanSetupRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutMobileScanSetupResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutMobileScanSetupResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutMobileScanSetupResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/mobile-scans/start-scan":{"post":{"tags":["MobileScans"],"summary":"Starts a mobile scan for the given release","description":"Allowed Scopes: api-tenant, start-scans","operationId":"MobileScansV3_Scan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"startDate","in":"query","description":"The start date for the scan in MM/dd/yyyy HH:mm format","required":true,"type":"string","format":"date-time"},{"name":"assessmentTypeId","in":"query","description":"The assessment type id for the scan<br /><br />Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","required":true,"type":"integer","format":"int32"},{"name":"frameworkType","in":"query","description":"The framework type id. Only iOS and Android are supported at this time","required":true,"type":"string","enum":["iOS","Android"]},{"name":"timeZone","in":"query","description":"The time zone<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","required":true,"type":"string"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"entitlementId","in":"query","description":"The entitlement id to consume","required":true,"type":"integer","format":"int32"},{"name":"entitlementFrequencyType","in":"query","description":"The entitlement frequency type","required":true,"type":"string","enum":["SingleScan","Subscription"]},{"name":"fileName","in":"query","description":"The uploaded file name with extension","required":false,"type":"string"},{"name":"isRemediationScan","in":"query","description":"Indicates if the scan is a remediation scan. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"isBundledAssessment","in":"query","description":"Indicates if the assessment is a bundled assessment. If not supplied legacy behavior will apply. Value defaults to null if not specified.","required":false,"type":"boolean"},{"name":"parentAssessmentTypeId","in":"query","description":"The parent assessment type id for the bundled assessment. If not supplied legacy behavior will apply","required":false,"type":"integer","format":"int32"},{"name":"scanMethodType","in":"query","description":"The method of starting a scan","required":false,"type":"string","enum":["IDE","CICD","Other","API"]},{"name":"scanTool","in":"query","description":"The tool used for scanning","required":false,"type":"string"},{"name":"scanToolVersion","in":"query","description":"The version for the scan tool used for scanning","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostMobileScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/mobile-scans/import-scan":{"put":{"tags":["MobileScans"],"summary":"Saves the contents to import scan file","description":"Allowed Scopes: api-tenant, start-scans","operationId":"MobileScansV3_PutImportScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to import","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"fileLength","in":"query","description":"The number of bytes of the file being imported","required":true,"type":"integer","format":"int64"},{"name":"importScanSessionId","in":"query","description":"The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutImportScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/multi-factor-authorization-code":{"post":{"tags":["MultiFactorAuthorizationCode"],"summary":"Send an Authorization code","operationId":"MultiFactorAuthorizationCodeV3_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"the username, password, and authorization method","required":true,"schema":{"$ref":"#/definitions/PostMultiFactorAuthorizationCodeRequest"}}],"responses":{"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/notifications/unread":{"get":{"tags":["Notifications"],"summary":"Get a list of unread notifications","description":"Allowed Scopes: api-tenant, manage-notifications","operationId":"NotificationsV3_GetUnreadNotifications","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/NotificationListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/notifications/read":{"get":{"tags":["Notifications"],"summary":"Get a list of read notifications","description":"Allowed Scopes: api-tenant, manage-notifications","operationId":"NotificationsV3_GetReadNotifications","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/NotificationListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/notifications/markasread":{"post":{"tags":["Notifications"],"summary":"Marks the notification(s) as read","description":"Allowed Scopes: api-tenant, manage-notifications","operationId":"NotificationsV3_MarkNotificaitonsAsRead","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"MarkNotificaitonsAsReadRequest model","required":true,"schema":{"$ref":"#/definitions/MarkNotificaitonsAsReadRequest"}}],"responses":{"204":{"description":"NoContent"},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/applications/open-source-components":{"get":{"tags":["OpenSourceComponents"],"summary":"Retrieve a collection of open source components.","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"OpenSourceComponentsV3_GetOpenSourceComponents","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"openSourceScanType","in":"query","description":"The source of component data.","required":false,"type":"string","enum":["Sonatype","CycloneDx","Debricked"]},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: licenses, packageUrl, vulnerabilityCounts","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"},{"name":"returnTotalComponentCount","in":"query","description":"If true return the total number of components. Default is true.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/OpenSourceComponentListResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/open-source-scans/{scanId}/sbom":{"get":{"tags":["OpenSourceComponents"],"summary":"Download the Open Source SBOM file","description":"Allowed Scopes: api-tenant, view-issues","operationId":"OpenSourceComponentsV3_DownloadOpenSourceSbomFile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"},{"name":"format","in":"query","description":"The format of the SBOM file (e.g., \"CycloneDx\" or \"SPDx\")","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/open-source-scans/start-scan":{"post":{"tags":["OpenSourceScans"],"summary":"Start an open source scan","description":"Allowed Scopes: api-tenant, start-scans","operationId":"OpenSourceScansV3_StartScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostStartScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/personal-access-tokens/{personalAccessTokenId}":{"get":{"tags":["PersonalAccessTokens"],"summary":"Get a specific personal access token","description":"Allowed Scopes: api-tenant","operationId":"PersonalAccessTokensV3_GetPersonalAccessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"personalAccessTokenId","in":"path","description":"The personal access token id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PersonalAccessTokenModel"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError"}}},"put":{"tags":["PersonalAccessTokens"],"summary":"Update an existing personal access token","description":"Allowed Scopes: api-tenant","operationId":"PersonalAccessTokensV3_PutPersonalAccessToken","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"personalAccessTokenId","in":"path","description":"The personal access token ID","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"Request containing the updated token information","required":true,"schema":{"$ref":"#/definitions/PutPersonalAccessTokenRequest"}}],"responses":{"200":{"description":"Ok"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["PersonalAccessTokens"],"summary":"Deletes a personal access token","description":"Allowed Scopes: api-tenant","operationId":"PersonalAccessTokensV3_DeletePersonalAccessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"personalAccessTokenId","in":"path","description":"The personal access token ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError"}}}},"/api/v3/personal-access-tokens":{"get":{"tags":["PersonalAccessTokens"],"summary":"Returns a list of personal access tokens.","description":"Allowed Scopes: api-tenant\r\n            \r\nFor security leads the returned list includes all personal access tokens in the tenant. Users in other roles can only query their own personal access tokens.","operationId":"PersonalAccessTokensV3_GetPersonalAccessTokens","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />The supported field names are name and userName. Note that filtering on userName is only available to security leads.\r\n<br /><br />Filtering is not supported for the following fields: allowedScopes, id, isAuthorized, lastSuccessfulLoginDate, lastSuccessfulLoginIpAddress, secretExpirationDate, secretLifetimeDays, userId","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PersonalAccessTokenModelListResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"InternalServerError"}}},"post":{"tags":["PersonalAccessTokens"],"summary":"Creates a personal access token.","description":"Allowed Scopes: api-tenant\r\n            \r\nThe reqeust body should include either secretLifetimeDays or secretExpirationDate. If both are specified secretLifetimeDays is ignored.","operationId":"PersonalAccessTokensV3_PostPersonalAccessToken","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/PostPersonalAccessTokenRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CreatePersonalAccessTokenResult"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError"}}}},"/api/v3/personal-access-tokens/{personalAccessTokenId}/secret":{"put":{"tags":["PersonalAccessTokens"],"summary":"Creates a new personal access token secret.","description":"Allowed Scopes: api-tenant\r\n            \r\nCreating a new personal access token secret will void the current secret.\r\n            \r\nThe reqeust body should include either secretLifetimeDays or secretExpirationDate. If both are specified secretLifetimeDays is ignored.","operationId":"PersonalAccessTokensV3_PutPersonalAccessTokenSecret","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"personalAccessTokenId","in":"path","description":"The personal access token ID","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"Request containing secret lifetime or expiration date","required":true,"schema":{"$ref":"#/definitions/PutPersonalAccessTokenSecretRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CreatePersonalAccessTokenResult"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}":{"get":{"tags":["Releases"],"summary":"Returns the specific release","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_GetRelease","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Release"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["Releases"],"summary":"Updates an existing release","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ReleasesV3_PutRelease","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutReleaseRequest model","required":true,"schema":{"$ref":"#/definitions/PutReleaseRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutReleaseResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutReleaseResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutReleaseResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["Releases"],"summary":"Deletes the given release","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ReleasesV3_DeleteRelease","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteReleaseResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/DeleteReleaseResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases":{"get":{"tags":["Releases"],"summary":"Returns a list of releases","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_GetReleases","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: suspended","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"},{"name":"modifiedStartDate","in":"query","description":"The modified on or after date.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReleaseListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Releases"],"summary":"Creates a new release","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ReleasesV3_PostRelease","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"PostReleaseRequest model","required":true,"schema":{"$ref":"#/definitions/PostReleaseRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostReleaseResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/scans/{scanId}/polling-summary":{"get":{"tags":["Releases"],"summary":"Returns Scan status for a specific scan","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_GetReleaseScanByScanId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PollingScanSummary"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/fpr":{"get":{"tags":["Releases"],"summary":"Get the fpr for the given release","description":"Allowed Scopes: api-tenant, view-issues","operationId":"ReleasesV3_GetReleasesFPR","consumes":[],"produces":["application/octet-stream"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"scanType","in":"query","description":"The scan type","required":true,"type":"string","enum":["Static","Dynamic","Mobile","Monitoring","Network","OpenSource","SASTAviator"]}],"responses":{"200":{"description":"Ok","schema":{"type":"file"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/category-rollups":{"get":{"tags":["Releases"],"summary":"List and count of vulnerabilities categories, by severity for this release","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_CategoryRollups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"showFixed","in":"query","description":"Indicates of vulnerabilities marked as fixed should be included. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"vulnerabilitiesSeverityType","in":"query","required":false,"type":"string","enum":["Low","Medium","High","Critical","Best_Practice","Info"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/CategoryRollupsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/scans/{scanId}":{"get":{"tags":["Releases"],"summary":"Returns summary information for the requested scan id","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_GetReleaseScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Scan"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/scans":{"get":{"tags":["Releases"],"summary":"Get a list of scans for a release","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ReleasesV3_GetScansByReleaseId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ScanListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/audit-action":{"post":{"tags":["Releases"],"summary":"Sets the audit action for the given release","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"ReleasesV3_PostAuditAction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostAuditActionRequest model","required":true,"schema":{"$ref":"#/definitions/PostAuditActionRequest"}}],"responses":{"204":{"description":"NoContent"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/audit-options":{"get":{"tags":["Releases"],"summary":"Get audit options for the given release","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"ReleasesV3_GetAuditOptions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetAuditOptionsResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/static-scan-options":{"get":{"tags":["Releases"],"summary":"Get a list of options available for starting a static scan","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_GetStaticScanOptions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"technologyStack","in":"query","description":"The technology stack<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=TechnologyTypes","required":false,"type":"string"},{"name":"languageLevel","in":"query","description":"The language level<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=LanguageLevels","required":false,"type":"string"},{"name":"assessmentTypeId","in":"query","description":"The assessment type id for the scan<br /><br />Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types<br /><br />If this parameter is supplied entitlementFrequencyType is also required","required":false,"type":"integer","format":"int32"},{"name":"entitlementFrequencyType","in":"query","description":"The entitlement frequency type<br>If this parameter is supplied assessmentTypeId is also required</br>","required":false,"type":"string","enum":["SingleScan","Subscription"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetStaticScanOptionsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/assessment-types":{"get":{"tags":["Releases"],"summary":"Get a list of available assessment types for the given release","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_GetAssessmentTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"scanType","in":"query","description":"The scan type","required":true,"type":"string","enum":["Static","Dynamic","Mobile","Monitoring","Network","OpenSource","SASTAviator"]},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: suspended","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReleaseAssessmentTypeListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/import-scan-session-id":{"get":{"tags":["Releases"],"summary":"Initiates an import scan session","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_GetImportScanSessionId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to import","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetImportScanSessionIdResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/open-source-scans/import-cyclonedx-sbom":{"put":{"tags":["Releases"],"summary":"Imports a CycloneDx Software Bill of Materials (SBOM)","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_PutImportScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"importScanSessionId","in":"query","description":"The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id","required":true,"type":"string"},{"name":"releaseId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutImportScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/scans/{scanId}/cancel-scan":{"post":{"tags":["Releases"],"summary":"Cancels a scan","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_PostCancelScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/PostCancelScanResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/static-scan-bsi-token":{"get":{"tags":["Releases"],"summary":"Get the build server integration token for the given release","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ReleasesV3_GetStaticScanBSIToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetStaticScanBSITokenResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/{reportId}":{"get":{"tags":["Reports"],"summary":"Get report summary data for the given report","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_GetReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportId","in":"path","description":"The report id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Report"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["Reports"],"summary":"Delete a report","description":"Allowed Scopes: api-tenant, manage-reports","operationId":"ReportsV3_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportId","in":"path","description":"The report id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteReportResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports":{"get":{"tags":["Reports"],"summary":"Get a list of report summary data","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_GetReports","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReportListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Reports"],"summary":"Create a new report","description":"Allowed Scopes: api-tenant, manage-reports","operationId":"ReportsV3_PostReport","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"PostReportRequest model","required":true,"schema":{"$ref":"#/definitions/PostReportRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostReportResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/{reportId}/download":{"get":{"tags":["Reports"],"summary":"Download the report in binary format","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_Download","consumes":[],"produces":["application/octet-stream"],"parameters":[{"name":"reportId","in":"path","description":"The report id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"file"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/dataexports":{"get":{"tags":["Reports"],"summary":"Get a list of export report summary data","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_GetDataExports","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DataExportListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Reports"],"summary":"Create a new data export","description":"Allowed Scopes: api-tenant, manage-reports","operationId":"ReportsV3_PostDataExport","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"PostDataExportRequest model","required":true,"schema":{"$ref":"#/definitions/PostDataExportRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/PostDataExportResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/dataexports/{dataExportId}/download":{"get":{"tags":["Reports"],"summary":"Download the export report in binary format","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_DownloadExport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"dataExportId","in":"path","description":"The data export id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/dataexports/templates":{"get":{"tags":["Reports"],"summary":"Get a list of data export templates","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_GetDataExportTemplates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DataExportTemplateListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/reports/dataexports/{dataExportId}":{"get":{"tags":["Reports"],"summary":"Get data export details","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ReportsV3_GetDataExport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"dataExportId","in":"path","description":"The data export id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DataExport"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans":{"get":{"tags":["Scans"],"summary":"Returns a list of scans","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ScansV3_GetScans","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startedOnStartDate","in":"query","description":"The started on start date.","required":false,"type":"string","format":"date-time"},{"name":"startedOnEndDate","in":"query","description":"The started on end date.","required":false,"type":"string","format":"date-time"},{"name":"completedOnStartDate","in":"query","description":"The completed on start date.","required":false,"type":"string","format":"date-time"},{"name":"completedOnEndDate","in":"query","description":"The completed on end date.","required":false,"type":"string","format":"date-time"},{"name":"modifiedStartDate","in":"query","description":"The modified on or after date.","required":false,"type":"string","format":"date-time"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ScanListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/summary":{"get":{"tags":["Scans"],"summary":"Returns summary information for the requested scan id","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ScansV3_GetScanSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ScanSummary"}},"202":{"description":"Accepted"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/manifest":{"get":{"tags":["Scans"],"summary":"Download the scan manifest","description":"Allowed Scopes: api-tenant, view-apps","operationId":"ScansV3_DownloadManifest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/site-tree":{"get":{"tags":["Scans"],"summary":"Get the site tree","description":"Allowed Scopes: api-tenant, view-reports","operationId":"ScansV3_GetSiteTree","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/SiteTreeListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/static-source-file":{"get":{"tags":["Scans"],"summary":"Download the static scan source file","description":"Allowed Scopes: api-tenant, start-scans","operationId":"ScansV3_DownloadStaticScanSourceFile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/fpr":{"get":{"tags":["Scans"],"summary":"Download the FPR file for the given ScanId","description":"Allowed Scopes: api-tenant, view-issues","operationId":"ScansV3_GetFPRByScanId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/scans/{scanId}/mobile-scans/payload-validation-results":{"get":{"tags":["Scans"],"summary":"Returns mobile validation status and results","description":"<remarks>Allowed Scopes: api-tenant, view-apps</remarks>","operationId":"ScansV3_GetValidationResults","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MobileValidationStatus"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3scans/{scanId}":{"put":{"tags":["Scans"],"summary":"Updates an existing scan","description":"Allowed Scopes: api-tenant, manage-apps","operationId":"ScansV3_PutScan","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"scanId","in":"path","description":"The scan id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutScanRequest model","required":true,"schema":{"$ref":"#/definitions/PutScanRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutScanResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/PutScanResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutScanResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/static-scans/start-scan":{"post":{"tags":["StaticScans"],"summary":"Start a static scan","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_StartScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"assessmentTypeId","in":"query","description":"The assessment type id for the scan<br /><br />Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"entitlementId","in":"query","description":"The entitlement id to consume","required":true,"type":"integer","format":"int32"},{"name":"entitlementFrequencyType","in":"query","description":"The entitlement frequency type","required":true,"type":"string","enum":["SingleScan","Subscription"]},{"name":"technologyStack","in":"query","description":"The technology stack<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=TechnologyTypes","required":false,"type":"string"},{"name":"languageLevel","in":"query","description":"The language level<br /><br />Values can be obtained by calling GET /api/v3/lookup-items?type=LanguageLevels","required":false,"type":"string"},{"name":"isRemediationScan","in":"query","description":"Indicates of the scan is a remediation scan. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"doSonatypeScan","in":"query","description":"Obsolete. Use doOpenSourceScan instead. This parameter may be removed in a future release. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"excludeThirdPartyLibs","in":"query","description":"Indicates if third party libraries should be excluded. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"scanPreferenceType","in":"query","description":"This parameter is depcrecated.","required":false,"type":"string","enum":["Standard","Express"]},{"name":"auditPreferenceType","in":"query","description":"The audit preference type","required":false,"type":"string","enum":["Manual","Automated"]},{"name":"fallbackToActiveEntitlement","in":"query","description":"Use existing active entitlement if specified entitlement is expired. Value defaults to true if not specified.","required":false,"type":"boolean"},{"name":"sastScanPolicy","in":"query","description":"The SAST policy used for a scan","required":false,"type":"string","enum":["Security","DevOps","Classic","FoD_Legacy_"]},{"name":"isBundledAssessment","in":"query","description":"Indicates if the assessment is a bundled assessment. If not supplied legacy behavior will apply. Value defaults to null if not specified.","required":false,"type":"boolean"},{"name":"parentAssessmentTypeId","in":"query","description":"The parent assessment type id for the bundled assessment. If not supplied legacy behavior will apply","required":false,"type":"integer","format":"int32"},{"name":"notes","in":"query","description":"The notes about the scan.","required":false,"type":"string"},{"name":"scanMethodType","in":"query","description":"The method of starting a scan","required":false,"type":"string","enum":["IDE","CICD","Other","API"]},{"name":"scanTool","in":"query","description":"The tool used for scanning","required":false,"type":"string"},{"name":"scanToolVersion","in":"query","description":"The version for the scan tool used for scanning","required":false,"type":"string"},{"name":"doOpenSourceScan","in":"query","description":"Indicates if an open source scan should be included. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"doBinaryScan","in":"query","description":"Indicates that mixed mode scanning should be used. Value defaults to null if not specified.","required":false,"type":"boolean"},{"name":"includeFortifyAviator","in":"query","description":"Indicates whether Fortify Remediation Aviator Addon Service is requested. Value defaults to null if not specified.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostStartScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/static-scans/start-scan-with-defaults":{"post":{"tags":["StaticScans"],"summary":"Start a static scan using the default settings","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_StartScanWithDefaults","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"isRemediationScan","in":"query","description":"Indicates of the scan is a remediation scan. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"notes","in":"query","description":"The notes about the scan.","required":false,"type":"string"},{"name":"scanMethodType","in":"query","description":"The method of starting a scan","required":false,"type":"string","enum":["IDE","CICD","Other","API"]},{"name":"scanTool","in":"query","description":"The tool used for scanning","required":false,"type":"string"},{"name":"scanToolVersion","in":"query","description":"The version for the scan tool used for scanning","required":false,"type":"string"},{"name":"fallbackToActiveEntitlement","in":"query","description":"Use existing active entitlement if specified entitlement is expired. Value defaults to true if not specified.","required":false,"type":"boolean"},{"name":"sastScanPolicy","in":"query","description":"The SAST scan policy to use","required":false,"type":"string","enum":["Security","DevOps","Classic","FoD_Legacy_"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostStartScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/static-scans/start-scan-advanced":{"post":{"tags":["StaticScans"],"summary":"Start a static scan using advanced options","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_StartScanAdvanced","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"entitlementPreferenceType","in":"query","description":"The entitlement preference type","required":true,"type":"string","enum":["SingleScanOnly","SubscriptionOnly","SingleScanFirstThenSubscription","SubscriptionFirstThenSingleScan"]},{"name":"purchaseEntitlement","in":"query","description":"Indicates if an entitlement should be purchased if one is not available. Value defaults to true if not specified.","required":true,"type":"boolean"},{"name":"remdiationScanPreferenceType","in":"query","description":"The remdiation scan preference type","required":true,"type":"string","enum":["RemediationScanIfAvailable","RemediationScanOnly","NonRemediationScanOnly"]},{"name":"inProgressScanActionType","in":"query","description":"The action to take for in-progress scans for the given release","required":true,"type":"string","enum":["DoNotStartScan","CancelInProgressScan","Queue"]},{"name":"scanMethodType","in":"query","description":"The method of starting a scan","required":true,"type":"string","enum":["IDE","CICD","Other","API"]},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"bsiToken","in":"query","description":"The build server integration token for the release","required":false,"type":"string"},{"name":"notes","in":"query","description":"The notes about the scan.","required":false,"type":"string"},{"name":"scanTool","in":"query","description":"The tool used for scanning","required":false,"type":"string"},{"name":"scanToolVersion","in":"query","description":"The version for the scan tool used for scanning","required":false,"type":"string"},{"name":"entitlementId","in":"query","description":"The entitlement id to consume","required":false,"type":"integer","format":"int32"},{"name":"fallbackToActiveEntitlement","in":"query","description":"Use existing active entitlement if specified entitlement is expired. Value defaults to true if not specified.","required":false,"type":"boolean"},{"name":"includeFortifyAviator","in":"query","description":"Indicates whether Fortify Remediation Aviator Addon Service is requested. Value defaults to null if not specified.","required":false,"type":"boolean"},{"name":"doOpenSourceScan","in":"query","description":"Indicates if an open source scan should be included. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"assessmentTypeId","in":"query","description":"The assessment type id for the scan<br /><br />Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","required":false,"type":"integer","format":"int32"},{"name":"auditPreferenceType","in":"query","description":"The audit preference type","required":false,"type":"string","enum":["Manual","Automated"]},{"name":"sastScanPolicy","in":"query","description":"The SAST scan policy to use","required":false,"type":"string","enum":["Security","DevOps","Classic","FoD_Legacy_"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostStartScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/static-scans/import-scan":{"put":{"tags":["StaticScans"],"summary":"Saves the contents to import scan file","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_PutImportScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to import","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"fileLength","in":"query","description":"The number of bytes of the file being imported","required":true,"type":"integer","format":"int64"},{"name":"importScanSessionId","in":"query","description":"The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutImportScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/static-scans/scan-setup":{"get":{"tags":["StaticScans"],"summary":"Get static scan setup details","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_GetStaticScanSetup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/StaticScanSetup"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["StaticScans"],"summary":"Saves static scan setup details","description":"Allowed Scopes: api-tenant, start-scans.","operationId":"StaticScansV3_PutStaticScanSetup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutStaticScanSetupRequest model","required":true,"schema":{"$ref":"#/definitions/PutStaticScanSetupRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutStaticScanSetupResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/PutStaticScanSetupResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/static-scans/import-sarif":{"put":{"tags":["StaticScans"],"summary":"Imports a Static Analysis Resource Interchange Format (SARIF) file","description":"Allowed Scopes: api-tenant, start-scans","operationId":"StaticScansV3_PutImportSarifScan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"Release Id of the scan to import","required":true,"type":"integer","format":"int32"},{"name":"fragNo","in":"query","description":"-1 indicates the fragment of bytes has been sent. The value starts with 0 and increments by 1 for each fragment of bytes sent","required":true,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"The offset of the bytes sent. 0 indicates the first bytes","required":true,"type":"integer","format":"int64"},{"name":"fileLength","in":"query","description":"The number of bytes of the file being imported","required":true,"type":"integer","format":"int64"},{"name":"importScanSessionId","in":"query","description":"The unique importScanSessionId to use for the session provided by GET /api/v3/releases/{releaseId}/import-scan-session-id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ImportSarifScanResponse"}},"202":{"description":"Accepted"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/tenant-entitlements":{"get":{"tags":["TenantEntitlements"],"summary":"Returns a list of active tenant entitlements","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantEntitlementsV3_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetTenantEntitlementResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/tenant-open-source-entitlements":{"get":{"tags":["TenantEntitlements"],"summary":"Returns a list of active open source entitlements for tenant","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantEntitlementsV3_GetOpenSourceEntitlements","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetTenantOpenSourceEntitlementsResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/tenant-heat-maps":{"get":{"tags":["TenantHeatMaps"],"summary":"Retrieve a list of tenant heat map values","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantHeatMapsV3_GetTenantHeatMap","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"sdlcStatus","in":"query","description":"SDLC status of releases to include.","required":true,"type":"string","enum":["Production","QA","Development","Retired"]},{"name":"daysFrom","in":"query","description":"Days back to get data","required":false,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/TenantHeatMap"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/tenants/features":{"get":{"tags":["Tenants"],"summary":"Get tenant features","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantsV3_GetFeatures","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/TenantFeatureListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/tenants":{"get":{"tags":["Tenants"],"summary":"Get tenant data","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantsV3_GetTenant","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetTenantResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/tenant-summary":{"get":{"tags":["TenantSummary"],"summary":"Retrieves a summary of the tenant","description":"Allowed Scopes: api-tenant, view-tenant-data","operationId":"TenantSummaryV3_GetTenantSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"daysFrom","in":"query","description":"Days back to look","required":false,"type":"integer","format":"int32"},{"name":"sdlcStatus","in":"query","description":"The SDLC Status to retrieve information about","required":false,"type":"string","enum":["Production","QA","Development","Retired"]}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/TenantSummaryListResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-application-access/{userId}":{"get":{"tags":["UserApplicationAccess"],"summary":"Get a list of applications a user has access to","description":"Allowed Scopes: api-tenant, view-users","operationId":"UserApplicationAccessV3_GetUserApplicationAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/UserApplicationAccessListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["UserApplicationAccess"],"summary":"Create user access for the given user and application(s)","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserApplicationAccessV3_PostUserApplicationAccess","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostUserApplicationAccessRequest model","required":true,"schema":{"$ref":"#/definitions/PostUserApplicationAccessRequest"}}],"responses":{"202":{"description":"Accepted"},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-application-access/{userId}/{applicationId}":{"delete":{"tags":["UserApplicationAccess"],"summary":"Delete user access for the given user and application","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserApplicationAccessV3_DeleteUserApplicationAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"},{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"202":{"description":"Accepted"},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-group-application-access/{userGroupId}":{"get":{"tags":["UserGroupApplicationAccess"],"summary":"Get a list of applications a user group has access to","description":"Allowed Scopes: api-tenant, view-users","operationId":"UserGroupApplicationAccessV3_GetUserGroupApplicationAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userGroupId","in":"path","description":"The user group id can be obtained by calling GET/api/v3/user-management/user-groups","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/UserGroupApplicationAccessListResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["UserGroupApplicationAccess"],"summary":"Create user group access for the given user group and application","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserGroupApplicationAccessV3_PostUserGroupApplicationAccess","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userGroupId","in":"path","description":"The user group id can be obtained by calling GET/api/v3/user-management/user-groups","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostUserGroupApplicationAccessRequest model","required":true,"schema":{"$ref":"#/definitions/PostUserGroupApplicationAccessRequest"}}],"responses":{"202":{"description":"Accepted"},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-group-application-access/{userGroupId}/{applicationId}":{"delete":{"tags":["UserGroupApplicationAccess"],"summary":"Delete user group access for the given user group and application","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserGroupApplicationAccessV3_DeleteUserGroupApplicationAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userGroupId","in":"path","description":"The user group id can be obtained by calling GET/api/v3/user-management/user-groups","required":true,"type":"integer","format":"int32"},{"name":"applicationId","in":"path","description":"The application id","required":true,"type":"integer","format":"int32"}],"responses":{"202":{"description":"Accepted"},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-management/user-groups":{"get":{"tags":["UserManagement"],"summary":"Get a list of user groups","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserManagementV3_GetUserGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: description","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/UserGroupListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["UserManagement"],"summary":"Create a user group","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserManagementV3_PostUserGroup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"<p>name: user group name</p>\r\n<p></p>\r\n<p>addAllUsers: Optional - if true add all tenant users to the group. Default is false</p>\r\n<p></p>\r\n<p>users: Optional - list of users to add to the group. If addAllUsers is true this list is ignored</p>","required":true,"schema":{"$ref":"#/definitions/PostUserGroupRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostUserGroupResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-management/user-groups/{groupId}":{"put":{"tags":["UserManagement"],"summary":"Update a user group","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserManagementV3_PutGroup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The user group id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"<p>name: new user group name</p>\r\n<p></p>\r\n<p>removeAllUsers: Optional - if true remove all users from the group. Default is false</p>\r\n<p></p>\r\n<p>addAllUsers: Optional - if true add all tenant users to the group. Default is false</p>\r\n<p></p>\r\n<p>Note, addAllUsers will take priority over removeAllUsers when both are set to true.</p>","required":true,"schema":{"$ref":"#/definitions/PutUserGroupRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GenericResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"delete":{"tags":["UserManagement"],"summary":"Delete a user group","description":"Allowed Scopes: api-tenant, manage-user","operationId":"UserManagementV3_DeleteGroup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The user group id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GenericResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/user-management/user-groups/{groupId}/members":{"get":{"tags":["UserManagement"],"summary":"Get a list of user group members","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UserManagementV3_GetGroupmembers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The user group id","required":true,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: description","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/UserListResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"patch":{"tags":["UserManagement"],"summary":"Update user group membership","description":"Allowed Scopes: api-tenant, manage-user","operationId":"UserManagementV3_UpdateGroupMembership","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The user group id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"<p>removeUsers: list of users' Id to remove from the group</p>\r\n<p></p>\r\n<p>addUsers: list of users' Id to add to the group</p>","required":true,"schema":{"$ref":"#/definitions/PatchUserGroupMembershipRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GenericResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/users/{userId}":{"get":{"tags":["Users"],"summary":"Get a specific user","description":"Allowed Scopes: api-tenant, view-users","operationId":"UsersV3_GetUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/User"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"put":{"tags":["Users"],"summary":"Update an existing user","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UsersV3_PutUser","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PutUserRequest model","required":true,"schema":{"$ref":"#/definitions/PutUserRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PutUserResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["Users"],"summary":"Delete a specific user","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UsersV3_DeleteUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The user id can be obtained by calling GET /api/v3/users","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/DeleteUserResponse"}},"401":{"description":"Unauthorized"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/users":{"get":{"tags":["Users"],"summary":"Get a list of users","description":"Allowed Scopes: api-tenant, view-users","operationId":"UsersV3_GetUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is 50.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/UserListResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}},"post":{"tags":["Users"],"summary":"Create a new user","description":"Allowed Scopes: api-tenant, manage-users","operationId":"UsersV3_PostUser","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"requestModel","in":"body","description":"PostUserRequest model","required":true,"schema":{"$ref":"#/definitions/PostUserRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PostUserResponse"}},"401":{"description":"Unauthorized"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/vulnerabilities":{"get":{"tags":["Vulnerabilities"],"summary":"Returns a list of vulnerabilities","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilities","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: auditPendingAuditorStatus, auditPendingSuppression, checkId, closedDate, closedStatus, falsePositiveChallenge, instanceId, pci1_2, sink, source, stig6, suppressedBy, timeToFixDays","required":false,"type":"string"},{"name":"orderBy","in":"query","description":"The field name to order the results by.","required":false,"type":"string"},{"name":"orderByDirection","in":"query","description":"The direction to order the results by. ASC and DESC are valid values.","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the starting record. 0 indicates the first record.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Maximum records to return. The maximum value allowed is in Tenant's 'Max Number of Vulnerabilities Records Per API Call'.","required":false,"type":"integer","format":"int32"},{"name":"excludeFilters","in":"query","description":"Indicates if filter data should be excluded in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"includeFixed","in":"query","description":"Indicates if items that have been fixed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"includeSuppressed","in":"query","description":"Indicates if items that have been suppressed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"fortifyAviator","in":"query","description":"Indicates if Fortify Remediation Aviator audited items should be included in the return value. Value defaults to null if not specified.","required":false,"type":"boolean"},{"name":"keywordSearch","in":"query","description":"Used for keyword searches","required":false,"type":"string"},{"name":"lastModifiedDate","in":"query","description":"Indicates the last modified date of the vulnerability. The format of the date is YYYY/MM/DD.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/GetVulnerabilitiesResponseVulnerabilityListItem"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data":{"get":{"tags":["Vulnerabilities"],"summary":"Returns all of the data for the vulnerability","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityAllData","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"includeSystemEvents","in":"query","description":"Include system events in the return data. Value defaults to false if not specified.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityAllData"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/summary":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability summary","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilitySummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilitySummary"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/details":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability details","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityDetails"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/recommendations":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability recommendations","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityRecommendations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityRecommendations"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/history":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability history","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityHistory","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"includeSystemEvents","in":"query","description":"Include system events in the return data. Value defaults to false if not specified.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityHistory"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/screenshots":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability screenshots","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityScreenshots","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityScreenshot"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/screenshot/{screenshotId}":{"get":{"tags":["Vulnerabilities"],"summary":"Returns a screenshot","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetScreenshot","consumes":[],"produces":["application/octet-stream"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"screenshotId","in":"path","description":"The screenshot id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"type":"file"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/request-response":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability request and response","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityRequestResponse","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityRequestResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/headers":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability headers","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityHeaders","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityHeaders"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/parameters":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability parameters","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityParameters","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityParameters"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability traces","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityTraces","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityTrace"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces/{traceIndex}/{traceEntryIndex}/code":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the trace code for the specific index","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityTraceCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"traceIndex","in":"path","description":"The trace index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data","required":true,"type":"integer","format":"int32"},{"name":"traceEntryIndex","in":"path","description":"The trace entry index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityTraceCode"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces/{traceIndex}/{traceEntryIndex}/snippet":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the trace snippet for the specific index","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityTraceSnippet","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"traceIndex","in":"path","description":"The trace index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data","required":true,"type":"integer","format":"int32"},{"name":"traceEntryIndex","in":"path","description":"The trace entry index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityTraceCodeSnippet"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/audit-options":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability audit options","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityAuditOptions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityAuditOptions"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/bulk-edit":{"post":{"tags":["Vulnerabilities"],"summary":"Saves audit data for the vulnerabilities","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"VulnerabilitiesV3_PostVulnerabilityEdit","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostVulnerabilityBulkEditRequest model","required":true,"schema":{"$ref":"#/definitions/PostVulnerabilityBulkEditRequest"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/PostVulnerabilityBulkEditResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerability-filters":{"get":{"tags":["Vulnerabilities"],"summary":"Get available vulnerability filters","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityFilters","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"filters","in":"query","description":"A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: auditPendingAuditorStatus, auditPendingSuppression, checkId, closedDate, closedStatus, falsePositiveChallenge, instanceId, pci1_2, sink, source, stig6, suppressedBy, timeToFixDays","required":false,"type":"string"},{"name":"fieldName","in":"query","description":"The specific field to return","required":false,"type":"string"},{"name":"includeFixed","in":"query","description":"Indicates if items that have been fixed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"includeSuppressed","in":"query","description":"Indicates if items that have been suppressed should be included in the return value. Value defaults to false if not specified.","required":false,"type":"boolean"},{"name":"keywordSearch","in":"query","description":"Used for keyword searches","required":false,"type":"string"},{"name":"fields","in":"query","description":"Comma separated list of fields to return.","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FieldFilterListResponse"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/bug-link":{"post":{"tags":["Vulnerabilities"],"summary":"Saves bug tracker url for the vulnerabilities","description":"Allowed Scopes: api-tenant, manage-issues","operationId":"VulnerabilitiesV3_PostVulnerabilityBugLink","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded","multipart/form-data"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"requestModel","in":"body","description":"PostVulnerabilityBugLinkRequest model","required":true,"schema":{"$ref":"#/definitions/PostVulnerabilityBugLinkRequest"}}],"responses":{"204":{"description":"NoContent"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"422":{"description":"UnprocessableEntity","schema":{"$ref":"#/definitions/ErrorResponse"}},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/comments":{"get":{"tags":["Vulnerabilities"],"summary":"Returns the vulnerability audit comments","description":"Allowed Scopes: api-tenant, view-issues","operationId":"VulnerabilitiesV3_GetVulnerabilityAuditComments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"},{"name":"userName","in":"query","description":"The username to get user specific comments","required":false,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/VulnerabilityAuditCommentsResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}},"/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/aviator-remediation-guidance":{"get":{"tags":["Vulnerabilities"],"summary":"Returns machine readable aviator remediation details in json format for each individual issue","operationId":"VulnerabilitiesV3_GetAviatorRemediationGuidanceForVulneribility","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"releaseId","in":"path","description":"The release id","required":true,"type":"integer","format":"int32"},{"name":"vulnId","in":"path","description":"Field accepts \"id\" or \"vulnId\". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"NotFound"},"429":{"description":"TooManyRequests"},"500":{"description":"InternalServerError"}}}}},"definitions":{"ApiKeyListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/ApiKey"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"ApiKey":{"type":"object","properties":{"apiKeyId":{"format":"int32","description":"API Key Id","type":"integer"},"name":{"description":"API Key Name","type":"string"},"isAuthorized":{"description":"Indicates whether or not the api key is authorized","type":"boolean"},"apiKey":{"description":"API Key","type":"string"},"grantType":{"description":"Authorization Grant Type","enum":["Authorization_Code","Implicit","Resource_Owner_Password_Credentials","Client_Credentials"],"type":"string"},"role":{"description":"The API key role","type":"string"},"lastLoginIpAddress":{"description":"The last Successful Login IpAddress","type":"string"},"lastLoginDate":{"format":"date-time","description":"The last Successful Login Date","type":"string"}}},"ApiKeyRequest":{"required":["name","roleId"],"type":"object","properties":{"name":{"description":"API Key Name","type":"string"},"isAuthorized":{"description":"Authorized app to use API","type":"boolean"},"roleId":{"description":"The role id. Values can be obtained by calling GET /api/v3/lookup-items?type=ApiRoles","enum":["Read_Only","Start_Scans","Manage_Applications","Security_Lead","Manage_Users"],"type":"string"}}},"PostApiKeyResponse":{"type":"object","properties":{"apiKeyId":{"format":"int32","description":"API Key Id","type":"integer"},"apiKey":{"description":"API Key","type":"string"},"secret":{"description":"API Secret","type":"string"}}},"ErrorResponse":{"description":"Error Response","type":"object","properties":{"errors":{"description":"List of errors","type":"array","items":{"$ref":"#/definitions/Error"}}}},"Error":{"description":"Error","type":"object","properties":{"errorCode":{"format":"int32","description":"The error code","type":"integer"},"message":{"description":"The error message","type":"string"}}},"ApiKeyResponse":{"type":"object","properties":{"message":{"description":"Task Queued Message","type":"string"},"success":{"description":"Success","type":"boolean"}}},"DeleteApiKeyResponse":{"description":"Delete ApiKey Response","type":"object","properties":{"success":{"description":"Indicates if the apikey was deleted","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"ApiKeyApplicationAccessRequest":{"type":"object","properties":{"assignAllApplications":{"description":"Assign all applications","type":"boolean"},"applicationId":{"description":"List of Application ids to be assigned","type":"array","items":{"format":"int32","type":"integer"}}}},"ApiKeyApplicationListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/ApiKeyApplication"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"ApiKeyApplication":{"type":"object","properties":{"applicationId":{"format":"int32","description":"Assigned Application Id","type":"integer"},"applicationName":{"description":"Assigned Application name","type":"string"}}},"ApiKeyUnassignApplicationsRequest":{"type":"object","properties":{"unassignAllApplications":{"description":"Unassigns all applications","type":"boolean"},"applicationId":{"description":"List of Application ids to be unassigned","type":"array","items":{"format":"int32","type":"integer"}}}},"Application":{"description":"Application","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The name of the application","type":"string"},"applicationDescription":{"description":"Description of the application that will help you manage multiple applications","type":"string"},"applicationCreatedDate":{"format":"date-time","description":"The date the application was created","type":"string"},"businessCriticalityTypeId":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"},"businessCriticalityType":{"description":"The business criticality type name. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"string"},"emailList":{"description":"List the email addresses of additional people who should be informed of activity related to this release","type":"string"},"applicationTypeId":{"format":"int32","description":"The application type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ApplicationTypes","type":"integer"},"applicationType":{"description":"The application type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ApplicationTypes","type":"string"},"hasMicroservices":{"description":"Determines if the application has microservices","type":"boolean"},"attributes":{"description":"Application attributes","type":"array","items":{"$ref":"#/definitions/ApplicationAttributeExtended"}}}},"ApplicationAttributeExtended":{"description":"Application Attribute Extended","type":"object","properties":{"name":{"description":"Name of the attribute","type":"string"},"id":{"format":"int32","description":"Id of the attribute","type":"integer"},"value":{"description":"Value of the attribute","type":"string"}}},"PutApplicationRequest":{"description":"Put Application Request","required":["applicationName","businessCriticalityType"],"type":"object","properties":{"applicationName":{"description":"The application title","type":"string"},"applicationDescription":{"description":"Description of the application that will help you manage multiple applications","type":"string"},"emailList":{"description":"List the email addresses of additional people who should be informed of activity related to this release. Separate multiple email addresses with a semicolon or comma","type":"string"},"attributes":{"description":"Application attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}},"businessCriticalityType":{"description":"The business criticality type","enum":["High","Medium","Low"],"type":"string"}}},"ApplicationAttribute":{"description":"Attribute","type":"object","properties":{"id":{"format":"int32","description":"Id of the attribute","type":"integer"},"value":{"description":"Value of the attribute","type":"string"}}},"PutApplicationResponse":{"description":"Put Application Response","type":"object","properties":{"success":{"description":"Indicates if the application was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"DeleteApplicationResponse":{"description":"Delete Application Response","type":"object","properties":{"success":{"description":"Indicates if the application was deleted","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"ApplicationListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Application"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"PostApplicationRequest":{"description":"Post Application Request","required":["applicationName","applicationType","releaseName","businessCriticalityType","sdlcStatusType"],"type":"object","properties":{"applicationName":{"description":"The application title","type":"string"},"applicationDescription":{"description":"Description of the application that will help you manage multiple applications","type":"string"},"applicationType":{"description":"Indicates if the application is a mobile application","enum":["Web_Thick_Client","Mobile"],"type":"string"},"releaseName":{"description":"The release name","type":"string"},"releaseDescription":{"description":"Description to add additional details that help describe the release","type":"string"},"emailList":{"description":"List the email addresses of additional people who should be informed of activity related to this release. Separate multiple email addresses with a semicolon or comma","type":"string"},"ownerId":{"format":"int32","description":"Select an Owner from the list of registered users in your tenant. The \"Owner\" receives all email notifications related to this application","type":"integer"},"attributes":{"description":"Application attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}},"businessCriticalityType":{"description":"The business criticality id","enum":["High","Medium","Low"],"type":"string"},"sdlcStatusType":{"description":"The SDLC status id","enum":["Production","QA","Development","Retired"],"type":"string"},"hasMicroservices":{"description":"Determines if this is a Microservices application","type":"boolean"},"microservices":{"description":"A list of microservice names for all releases associated with this application","type":"array","items":{"type":"string"}},"releaseMicroserviceName":{"description":"The name of the Microservice to be associated with the newly created version","type":"string"},"userGroupIds":{"description":"List of user group ids that have access to the application. Values can be obtained by calling GET /api/v3/user-management/user-groups","type":"array","items":{"format":"int32","type":"integer"}}}},"PostApplicationResponse":{"description":"Post Application Response","type":"object","properties":{"applicationId":{"format":"int32","description":"The id of the application that was created","type":"integer"},"releaseId":{"format":"int32","type":"integer"},"microserviceId":{"format":"int32","type":"integer"},"success":{"description":"Indicates if the application was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"GetAutoReportResponse":{"description":"Get Auto Report Response","type":"object","properties":{"staticScanReportId":{"format":"int32","description":"The report id for static scans","type":"integer"},"staticScanReportName":{"description":"The report name for static scans","type":"string"},"dynamicScanReportId":{"format":"int32","description":"The report id for dynamic scans","type":"integer"},"dynamicScanReportName":{"description":"The report name for dynamic scans","type":"string"}}},"PostAutoReportRequest":{"description":"Post Auto Report Request","required":["emailReport","reportFormat"],"type":"object","properties":{"staticScanReportId":{"format":"int32","description":"The report id used for Static Scans","type":"integer"},"dynamicScanReportId":{"format":"int32","description":"The report id used for Dynamic Scans","type":"integer"},"emailReport":{"description":"Enable/Disable email reporting","type":"boolean"},"reportFormat":{"description":"The report format","enum":["Pdf","Html"],"type":"string"},"emailNotificationList":{"description":"List of emails separated by semicolon","type":"string"},"projectSDLCStatusTypes":{"description":"SDLC Status IDs","type":"array","items":{"enum":["Production","QA","Development","Retired"],"type":"string"}}}},"PostAutoReportResponse":{"description":"Post Auto Report Response","type":"object","properties":{"success":{"description":"Indicates if the auto report was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"GetApplicationUsersResponse":{"description":"Get Application Users Response","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"users":{"description":"A list of users that have access to the application","type":"array","items":{"$ref":"#/definitions/ApplicationUser"}}}},"ApplicationUser":{"description":"Application User","type":"object","properties":{"userId":{"format":"int32","description":"The user id","type":"integer"},"firstName":{"description":"The user first name","type":"string"},"lastName":{"description":"The user last name","type":"string"},"emailId":{"description":"The user email id","type":"string"},"roleId":{"format":"int32","description":"The user role id","type":"integer"},"roleName":{"description":"The user role name","type":"string"},"accessMethod":{"description":"The user access method","type":"string"}}},"GetApplicationUserGroupsResponse":{"description":"Get Application User Groups Response","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"userGroups":{"description":"A list of user groups that have access to the application","type":"array","items":{"$ref":"#/definitions/ApplicationUserGroup"}}}},"ApplicationUserGroup":{"description":"Application User","type":"object","properties":{"userGroupId":{"format":"int32","description":"The group id","type":"integer"},"userGroupName":{"description":"The group name","type":"string"}}},"ApplicationUserListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/ApplicationUser"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"ApplicationUserPermissions":{"description":"Application User Permissions","type":"object","properties":{"startDynamicScan":{"description":"Indicates if the user can start a dynamic scan","type":"boolean"},"startMobileScan":{"description":"Indicates if the user can start a mobile scan","type":"boolean"},"startStaticScan":{"description":"Indicates if the user can start a static scan","type":"boolean"},"configureDynamicScan":{"description":"Indicates if the user can configure a dynamic scan","type":"boolean"},"configureMobileScan":{"description":"Indicates if the user can configure a mobile scan","type":"boolean"},"configureStaticScan":{"description":"Indicates if the user can configure a static scan","type":"boolean"},"createRelease":{"description":"Indicates if the user can create a release","type":"boolean"},"auditIssues":{"description":"Indicates if the user can audit issues","type":"boolean"},"challengeIssues":{"description":"Indicates if the user can challenge issues","type":"boolean"},"editIssues":{"description":"Indicates if the user can edit issues","type":"boolean"},"downloadFPR":{"description":"Indicates if the user can download the FPR","type":"boolean"}}},"ReleaseListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Release"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"Release":{"description":"Release","type":"object","properties":{"releaseId":{"format":"int32","description":"Release identifier","type":"integer"},"releaseName":{"description":"Name of the release","type":"string"},"releaseDescription":{"description":"Description of the release","type":"string"},"suspended":{"description":"Indicates whether or not the release is suspended","type":"boolean"},"releaseCreatedDate":{"format":"date-time","description":"The date the release was created","type":"string"},"microserviceName":{"description":"Name of the microservice","type":"string"},"microserviceId":{"format":"int32","description":"ID of the microservice","type":"integer"},"applicationId":{"format":"int32","description":"Application id","type":"integer"},"applicationName":{"description":"Name of the application","type":"string"},"currentAnalysisStatusTypeId":{"format":"int32","description":"Current ananlysis status type id. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"currentAnalysisStatusType":{"description":"Current ananlysis status type. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"rating":{"format":"int32","description":"The current star rating (1-5)","type":"integer"},"critical":{"format":"int32","description":"Number of critical vulnerabilities","type":"integer"},"high":{"format":"int32","description":"Number of high vulnerabilities","type":"integer"},"medium":{"format":"int32","description":"Number of medium vulnerabilities","type":"integer"},"low":{"format":"int32","description":"Number of low vulnerabilities","type":"integer"},"staticCritical":{"format":"int32","description":"Number of critical vulnerabilities from static scans","type":"integer"},"staticHigh":{"format":"int32","description":"Number of high vulnerabilities from static scans","type":"integer"},"staticMedium":{"format":"int32","description":"Number of medium vulnerabilities from static scans","type":"integer"},"staticLow":{"format":"int32","description":"Number of low vulnerabilities from static scans","type":"integer"},"dynamicCritical":{"format":"int32","description":"Number of critical vulnerabilities from dynamic scans","type":"integer"},"dynamicHigh":{"format":"int32","description":"Number of high vulnerabilities from dynamic scans","type":"integer"},"dynamicMedium":{"format":"int32","description":"Number of medium vulnerabilities from dynamic scans","type":"integer"},"dynamicLow":{"format":"int32","description":"Number of low vulnerabilities from dynamic scans","type":"integer"},"mobileCritical":{"format":"int32","description":"Number of critical vulnerabilities from mobile scans","type":"integer"},"mobileHigh":{"format":"int32","description":"Number of high vulnerabilities from mobile scans","type":"integer"},"mobileMedium":{"format":"int32","description":"Number of medium vulnerabilities from mobile scans","type":"integer"},"mobileLow":{"format":"int32","description":"Number of low vulnerabilities from mobile scans","type":"integer"},"openSourceCritical":{"format":"int32","description":"Number of critical vulnerabilities for open source scans.","type":"integer"},"openSourceHigh":{"format":"int32","description":"Number of high vulnerabilities for open source scans.","type":"integer"},"openSourceMedium":{"format":"int32","description":"Number of medium vulnerabilities for open source scans.","type":"integer"},"openSourceLow":{"format":"int32","description":"Number of low vulnerabilities for open source scans.","type":"integer"},"currentStaticScanId":{"format":"int32","description":"Current static scan identifier","type":"integer"},"currentDynamicScanId":{"format":"int32","description":"Current dynamic scan identifier","type":"integer"},"currentMobileScanId":{"format":"int32","description":"Current Mobile Scan Id","type":"integer"},"staticAnalysisStatusType":{"description":"Current status of the static scan on this release (null if no static scan). Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"dynamicAnalysisStatusType":{"description":"Current status of the dynamic scan on this release (null if no dynamic scan). Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"mobileAnalysisStatusType":{"description":"Current status of the mobile scan on this release (null if no mobile scan). Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"staticAnalysisStatusTypeId":{"format":"int32","description":"Current status of the static scan as a numberic identifier. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"dynamicAnalysisStatusTypeId":{"format":"int32","description":"Current status of the dynamic scan as a numberic identifier. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"mobileAnalysisStatusTypeId":{"format":"int32","description":"Current status of the mobile scan as a numberic identifier. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"staticScanDate":{"format":"date-time","description":"Static scan completed date","type":"string"},"dynamicScanDate":{"format":"date-time","description":"Dynamic scan completed date","type":"string"},"mobileScanDate":{"format":"date-time","description":"Mobile scan completed date","type":"string"},"issueCount":{"format":"int32","description":"Total number of issues","type":"integer"},"isPassed":{"description":"Pass/Failed status","type":"boolean"},"passFailReasonTypeId":{"format":"int32","description":"Reason for the scan pass/fail id. Values can be obtained by calling GET /api/v3/lookup-items?type=PassFailReasonTypes","type":"integer"},"passFailReasonType":{"description":"Reason for the scan pass/fail. Values can be obtained by calling GET /api/v3/lookup-items?type=PassFailReasonTypes","type":"string"},"sdlcStatusTypeId":{"format":"int32","description":"SDLC Status Type Id. Values can be obtained by calling GET /api/v3/lookup-items?type=SDLCStatusTypes","type":"integer"},"sdlcStatusType":{"description":"SDLC Status Type. Values can be obtained by calling GET /api/v3/lookup-items?type=SDLCStatusTypes","type":"string"},"ownerId":{"format":"int32","description":"Owner Id","type":"integer"},"IsDebrickedScanEnabled":{"description":"Is Debricked Scan Enabled","type":"boolean"},"attributes":{"description":"Release attributes","type":"array","items":{"$ref":"#/definitions/ApplicationAttributeExtended"}}}},"ApplicationIssueCountListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/ApplicationIssueCount"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"ApplicationIssueCount":{"type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The name of the application","type":"string"},"applicationDescription":{"description":"Description of the application that will help you manage multiple applications","type":"string"},"applicationCreatedDate":{"format":"date-time","description":"The date the application was created","type":"string"},"businessCriticalityTypeId":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"},"businessCriticalityType":{"description":"The business criticality type name. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"string"},"critical":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"},"high":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"},"medium":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"},"low":{"format":"int32","description":"The business criticality type id. Values can be obtained by calling GET /api/v3/lookup-items?type=BusinessCriticalityTypes","type":"integer"}}},"ScanListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Scan"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"Scan":{"description":"Scan","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The application name","type":"string"},"releaseId":{"format":"int32","description":"The release id","type":"integer"},"releaseName":{"description":"The release name","type":"string"},"scanId":{"format":"int32","description":"The scan id","type":"integer"},"scanTypeId":{"format":"int32","description":"The scan type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"integer"},"scanType":{"description":"The scan type. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"string"},"assessmentTypeId":{"format":"int32","description":"The assessment type id. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"assessmentTypeName":{"description":"The assessment type name. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"string"},"analysisStatusTypeId":{"format":"int32","description":"The analysis status type id. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"analysisStatusType":{"description":"The analysis status type. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"startedDateTime":{"format":"date-time","description":"The scan started date time","type":"string"},"completedDateTime":{"format":"date-time","description":"The scan completed date time","type":"string"},"totalIssues":{"format":"int32","description":"Total number of issues","type":"integer"},"issueCountCritical":{"format":"int32","description":"Total number of critical issues","type":"integer"},"issueCountHigh":{"format":"int32","description":"Total number of high issues","type":"integer"},"issueCountMedium":{"format":"int32","description":"Total number of medium issues","type":"integer"},"issueCountLow":{"format":"int32","description":"Total number of low issues","type":"integer"},"starRating":{"format":"int32","description":"The star rating","type":"integer"},"notes":{"description":"Scan notes","type":"string"},"isFalsePositiveChallenge":{"description":"Indicates if the scan is a false positive challenge","type":"boolean"},"isRemediationScan":{"description":"Indicates if the scan is a remediation scan","type":"boolean"},"entitlementId":{"format":"int32","description":"The entitlement id used for the given scan","type":"integer"},"entitlementUnitsConsumed":{"format":"int32","description":"The number of entitlement units used for the given scan","type":"integer"},"isSubscriptionEntitlement":{"description":"Indicates if the entitlement used for the given scan is a subscription entitlement","type":"boolean"},"pauseDetails":{"description":"The details for each time the scan has been paused/resumed.","type":"array","items":{"$ref":"#/definitions/ScanPauseDetail"}},"cancelReason":{"description":"Cancel Reason","type":"string"},"analysisStatusReasonNotes":{"description":"The Analysis Status Reason Notes","type":"string"},"scanMethodTypeId":{"format":"int32","description":"The scan method type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanMethodTypes","type":"integer"},"scanMethodTypeName":{"description":"The scan method type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanMethodTypes","type":"string"},"scanPolicyTypeId":{"format":"int32","description":"The scan policy type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanPolicyTypes","type":"integer"},"scanPolicyTypeName":{"description":"The scan policy type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanPolicyTypes","type":"string"},"scanTool":{"description":"The tool used for scanning","type":"string"},"scanToolVersion":{"description":"The version for the scan tool used for scanning","type":"string"},"attributes":{"description":"Scan attributes","type":"array","items":{"$ref":"#/definitions/ApplicationAttributeExtended"}}}},"ScanPauseDetail":{"description":"Scan Pause Details","type":"object","properties":{"pausedOn":{"format":"date-time","description":"The scan paused date/time.","type":"string"},"reason":{"description":"The reason the scan was paused.","type":"string"},"notes":{"description":"Optional notes regarding the scan paused.","type":"string"}}},"ApplicationBugTracker":{"description":"Application Bug Tracker Settings","type":"object","properties":{"bugTrackerTypeId":{"format":"int32","description":"The Bug Tracker Type Id","type":"integer"},"bugTrackerType":{"description":"The Bug Tracker Type name","type":"string"},"bugTrackerUrl":{"description":"The Bug Tracker Url","type":"string"},"enabled":{"description":"Whether the Bug Tracker is enabled","type":"boolean"},"autoClose":{"description":"Whether to auto-close bug when the issue is fix-validated","type":"boolean"},"levelOneProjectName":{"description":"The Bug Tracker's Domain/Product","type":"string"},"levelTwoProjectName":{"description":"The Bug Tracker' Component","type":"string"}}},"MicroserviceListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Microservice"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"Microservice":{"description":"Microservice","type":"object","properties":{"microserviceId":{"format":"int32","description":"The microservice id","type":"integer"},"microserviceName":{"description":"The microservice name","type":"string"},"releaseId":{"format":"int32","description":"The associated release for this microservice, if one exists","type":"integer"},"attributes":{"description":"Microservice attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttributeExtended"}}}},"PostMicroserviceRequest":{"description":"Post Microservice Request","type":"object","properties":{"microserviceName":{"description":"The microservice name","type":"string"},"attributes":{"description":"Microservice attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}}}},"PostMicroserviceResponse":{"description":"Post Microservice Response","type":"object","properties":{"microserviceId":{"format":"int32","description":"The id of the application that was created","type":"integer"},"success":{"description":"Indicates if the item was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"AuditTemplateListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/AuditTemplate"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"AuditTemplate":{"type":"object","properties":{"applicationId":{"format":"int32","type":"integer"},"scanType":{"type":"string"},"scanTypeId":{"format":"int32","type":"integer"},"conditions":{"type":"array","items":{"$ref":"#/definitions/AuditTemplateCondition"}},"action":{"$ref":"#/definitions/AuditTemplateAction"}}},"AuditTemplateCondition":{"type":"object","properties":{"field":{"type":"string"},"conditionType":{"type":"string"},"fieldValue":{"type":"string"},"operationType":{"type":"string"}}},"AuditTemplateAction":{"type":"object","properties":{"actionType":{"type":"string"},"severity":{"type":"string"},"severityId":{"format":"int32","type":"integer"},"suppressedStatus":{"type":"string"}}},"PutAuditTemplateFilterRequest":{"required":["scanType","action"],"type":"object","properties":{"scanType":{"description":"The scan type","enum":["Static","Dynamic","Mobile","Monitoring","Network","OpenSource","SASTAviator"],"type":"string"},"scanTypeId":{"format":"int32","description":"Scan Type Id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"integer"},"action":{"$ref":"#/definitions/PutAuditTemplateAction","description":"The action"},"conditions":{"description":"The conditions","type":"array","items":{"$ref":"#/definitions/PutAuditTemplateCondition"}}}},"PutAuditTemplateAction":{"description":"AuditTemplateAction","required":["actionType"],"type":"object","properties":{"actionType":{"description":"The Action type","enum":["Suppress","SetSeverity"],"type":"string"},"severity":{"description":"Severity Needs to be set if the Action is Set Severity","enum":["Critical","High","Medium","Low"],"type":"string"},"severityId":{"format":"int32","description":"Severity Id","type":"integer"},"suppressedStatus":{"type":"string"}}},"PutAuditTemplateCondition":{"description":"AuditTemplateCondition","type":"object","properties":{"conditionType":{"description":"The condition type","enum":["Contains","DoesNotContain","Equals","DoesNotEqual","Regex"],"type":"string"},"field":{"description":"The field","type":"string"},"fieldValue":{"description":"The field value","type":"string"},"operationType":{"description":"The Operation type","enum":["And","Or"],"type":"string"}}},"AuditTemplateResponse":{"type":"object","properties":{"applicationId":{"format":"int32","description":"The id of the application that was created","type":"integer"},"success":{"description":"Indicates if the application was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"GetVulnerabilitiesResponseVulnerabilityDTOLight":{"description":"Get Vulnerabilities Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/VulnerabilityDTOLight"}},"filters":{"description":"The list of filters","type":"array","items":{"$ref":"#/definitions/FieldFilter"}},"totalCount":{"format":"int32","description":"The total count of items","type":"integer"},"isRepositoryUpdating":{"description":"Indicates if the repository is being updated","type":"boolean"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"VulnerabilityDTOLight":{"type":"object","properties":{"id":{"format":"int32","description":"Id","type":"integer"},"vulnId":{"description":"Vulnerability id","type":"string"},"releaseId":{"format":"int32","description":"Release id","type":"integer"},"releaseName":{"description":"Release Name","type":"string"}}},"FieldFilter":{"description":"Field Filter","type":"object","properties":{"fieldName":{"description":"The field name","type":"string"},"fieldFilterValues":{"description":"List of field filter values","type":"array","items":{"$ref":"#/definitions/FieldFilterValue"}},"displayName":{"description":"The display name","type":"string"}}},"FieldFilterValue":{"description":"Field Filter Value","type":"object","properties":{"value":{"description":"The value property","type":"string"},"count":{"format":"int32","description":"Count of items in the filter","type":"integer"}}},"AttributeItemListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/AttributeItem"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"AttributeItem":{"description":"Attribute Item","type":"object","properties":{"id":{"format":"int32","description":"The attribute id","type":"integer"},"name":{"description":"The attribute name","type":"string"},"attributeTypeId":{"format":"int32","description":"The attribute type id. Values can be obtained by calling GET /api/v3/lookup-items?type=AttributeTypes","type":"integer"},"attributeType":{"description":"The attribute type. Values can be obtained by calling GET /api/v3/lookup-items?type=AttributeTypes","type":"string"},"attributeDataTypeId":{"format":"int32","description":"The attribute data type id. Values can be obtained by calling GET /api/v3/lookup-items?type=AttributeDataTypes","type":"integer"},"attributeDataType":{"description":"The attribute data type. Values can be obtained by calling GET /api/v3/lookup-items?type=AttributeDataTypes","type":"string"},"isRequired":{"description":"Indicates if the attribute is required","type":"boolean"},"isRestricted":{"description":"Indicates if the attribute is editable only by Security Leads","type":"boolean"},"defaultValue":{"description":"Default value for the attribute when both isRequired and isRestricted are true","type":"string"},"picklistValues":{"description":"A list of attribute item values","type":"array","items":{"$ref":"#/definitions/AttributeItemValue"}}}},"AttributeItemValue":{"description":"Attribute Item Value","type":"object","properties":{"id":{"format":"int32","description":"The id of the attribute item value","type":"integer"},"name":{"description":"The name of the attribute item value","type":"string"}}},"PostAttributeRequest":{"description":"Post Attrbute Request","required":["name","attributeType","attributeDataType"],"type":"object","properties":{"name":{"description":"Attribute name","type":"string"},"attributeType":{"description":"Attribute type","type":"string"},"attributeDataType":{"description":"Attribute data name","enum":["Picklist","Text","Boolean","Date","User"],"type":"string"},"isRequired":{"description":"Is attribute required","type":"boolean"},"isRestricted":{"description":"Is attribute editable only by SecLeads","type":"boolean"},"defaultValue":{"description":"Default value for the attribute. Required when both isRequired and isRestricted are true.","type":"string"},"picklistValues":{"description":"Picklist Values","type":"array","items":{"$ref":"#/definitions/AttributeValueItem"}}}},"AttributeValueItem":{"type":"object","properties":{"Name":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"}}},"PostAttributeResponse":{"description":"Post Attrbute Response","type":"object","properties":{"attributeId":{"format":"int32","description":"The id of the attribute that was created","type":"integer"},"success":{"description":"Indicates if the application was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PutAttributeRequest":{"description":"Put Attrbute Request","type":"object","properties":{"isRequired":{"description":"Is attribute required","type":"boolean"},"isRestricted":{"description":"Is attribute editable only by SecLeads","type":"boolean"},"defaultValue":{"description":"Default value for the attribute. Required when both isRequired and isRestricted are true.","type":"string"},"overwriteExistingValues":{"description":"Overwrite existing picklist values","type":"boolean"},"picklistValues":{"description":"Picklist Values","type":"array","items":{"type":"string"}}}},"PutAttributeResponse":{"description":"Put Attrbute Response","type":"object","properties":{"success":{"description":"Indicates if the attribute was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"GetDastAutomatedScanSetupResponse":{"type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"scanType":{"description":"Scan type. Values can be obtained by calling GET /api/v3/lookup-items?type=DastAutomatedScanTypes","type":"string"},"policy":{"description":"Policy type to scan the site. Values are obtained by calling api/v3/lookup-items?type=DastAutomatedScanPolicies","enum":["Standard","Api","CriticalsAndHighs","PassiveScan"],"type":"string"},"websiteAssessment":{"$ref":"#/definitions/Website","description":"Website assessment"},"apiAssessment":{"$ref":"#/definitions/API","description":"API assessment"},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"workflowdrivenAssessment":{"$ref":"#/definitions/WorkflowDriven","description":"Workflow driven assessment"},"loginMacroFileId":{"format":"int32","description":"Login macro file ID. Value is obtained by uploading login macro","type":"integer"},"requiresSiteAuthentication":{"description":"True if site authentication is required to scan the site, otherwise false","type":"boolean"},"allowFormSubmissions":{"description":"True to allow form submissions, otherwise false","type":"boolean"},"allowSameHostRedirects":{"description":"True to allow HTTP (:80) and HTTPS (:443) of the specified scan host, otherwise false","type":"boolean"},"restrictToDirectoryAndSubdirectories":{"description":"True to restrict to directory and subdirectories, otherwise false","type":"boolean"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"fileDetails":{"description":"Uploaded file details","type":"array","items":{"$ref":"#/definitions/FileDetails"}},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"hasUtilizedAdditionalServices":{"description":"True When the prior DAST Automated scan completed successfully using Add on services, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"Website":{"type":"object","properties":{"dynamicSiteUrl":{"description":"The dynamic site url","type":"string"},"requestLoginMacroFileCreation":{"description":"True if requesting one-time creation of login macro file by testing team, otherwise false","type":"boolean"},"loginMacroFileCreationDetails":{"$ref":"#/definitions/LoginMacroFileCreationDetails","description":"Login macro file creation details"},"enableRedundantPageDetection":{"description":"True to enable comparison of page structure to identify and exclude processing of redundant resources, otherwise false","type":"boolean"},"exclusionsList":{"description":"List of exclusions.","type":"array","items":{"$ref":"#/definitions/Exclusion"}}}},"API":{"type":"object","properties":{"apiType":{"description":"Api type","enum":["NotSet","OpenApi","GRPC","GraphQL","Postman"],"type":"string"},"openAPI":{"$ref":"#/definitions/OpenApi","description":"OpenApi scan details"},"graphQL":{"$ref":"#/definitions/GraphQl","description":"GraphQL Api scan details"},"gRPC":{"$ref":"#/definitions/Grpc","description":"gRPC Api scan details"},"postman":{"$ref":"#/definitions/Postman","description":"Postman Api scan details"}}},"WorkflowDriven":{"type":"object","properties":{"workflowDrivenMacro":{"description":"Workflow driven macro fileIds","type":"array","items":{"$ref":"#/definitions/WorkflowDrivenMacrosResponse"}}}},"NetworkAuthenticationSettings":{"type":"object","properties":{"networkAuthenticationType":{"description":"Network authentication type. Values are obtained by calling GET /api/v3/lookup-items?type=NetworkAuthenticationType","enum":["Basic","NTLM","Kerberos","Digest","Automatic","ADFS_CBT"],"type":"string"},"userName":{"description":"Network username","type":"string"},"password":{"description":"Network password","type":"string"}}},"FileDetails":{"type":"object","properties":{"fileId":{"format":"int32","description":"Uploaded file details: file Id","type":"integer"},"fileName":{"description":"Uploaded file details: file Name","type":"string"},"fileType":{"description":"Uploaded file details: file Type","type":"string"}}},"LoginMacroFileCreationDetails":{"type":"object","properties":{"primaryUsername":{"description":"Login macro settings: primary username to login with","type":"string"},"primaryPassword":{"description":"Login macro settings: primary account password to login with","type":"string"},"secondaryUsername":{"description":"Login macro settings: secondary username to login with","type":"string"},"secondaryPassword":{"description":"Login macro settings: secondary account password to login with","type":"string"}}},"Exclusion":{"type":"object","properties":{"value":{"description":"URL fragment to exclude from scanning.","type":"string"}}},"OpenApi":{"type":"object","properties":{"sourceType":{"description":"Specifies whether source is file ID or URL","enum":["FileId","Url"],"type":"string"},"sourceUrn":{"description":"File ID or URL","type":"string"},"apiKey":{"description":"API key","type":"string"}}},"GraphQl":{"type":"object","properties":{"sourceType":{"description":"Specifies whether source is file ID or URL","enum":["FileId","Url"],"type":"string"},"sourceUrn":{"description":"File ID or URL","type":"string"},"schemeType":{"description":"Api scheme type (Http, Https, or HttpHttps)","type":"string"},"host":{"description":"API host name or IP address with port number","type":"string"},"servicePath":{"description":"Directory path for the API service","type":"string"}}},"Grpc":{"type":"object","properties":{"fileId":{"format":"int32","description":"gRPC file ID. Value is obtained by uploading proto file","type":"integer"},"schemeType":{"description":"API scheme type (Http, Https, or HttpHttps)","type":"string"},"host":{"description":"API host name or IP address with port number","type":"string"},"servicePath":{"description":"Directory path for the API service","type":"string"}}},"Postman":{"type":"object","properties":{"collectionFileIds":{"description":"Postman collection file ID. Value is obtained by uploading Postman collection","type":"array","items":{"format":"int32","type":"integer"}}}},"WorkflowDrivenMacrosResponse":{"type":"object","properties":{"fileId":{"format":"int32","description":"Workflow-driven macro file ID. Value is obtained by uploading workflow-driven macro","type":"integer"},"allowedHosts":{"description":"Hostname or IP address with port number. Value is obtained by uploading workflow-driven macro","type":"array","items":{"type":"string"}}}},"PutDastAutomatedWebsiteScanSetupRequest":{"required":["dynamicSiteUrl","policy","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"dynamicSiteUrl":{"description":"Dynamic site URL","type":"string"},"enableRedundantPageDetection":{"description":"True to enable comparison of page structure to identify and exclude processing of redundant resources, otherwise false","type":"boolean"},"loginMacroFileId":{"format":"int32","description":"Login macro file ID. Value is obtained by uploading login macro","type":"integer"},"requiresSiteAuthentication":{"description":"True if site authentication is required to scan the site, otherwise false","type":"boolean"},"exclusionsList":{"description":"List of exclusions.","type":"array","items":{"$ref":"#/definitions/Exclusion"}},"restrictToDirectoryAndSubdirectories":{"description":"True to restrict to directory and subdirectories, otherwise false","type":"boolean"},"policy":{"description":"Policy type to scan the site. Values are obtained by calling api/v3/lookup-items?type=DastAutomatedScanPolicies","enum":["Standard","CriticalsAndHighs","PassiveScan"],"type":"string"},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"requestLoginMacroFileCreation":{"description":"True if requesting one-time creation of login macro file by testing team, otherwise false","type":"boolean"},"loginMacroFileCreationDetails":{"$ref":"#/definitions/LoginMacroFileCreationDetails","description":"Login macro file creation details"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"PutDastAutomatedWorkflowScanSetupRequest":{"required":["workflowDrivenMacro","policy","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"workflowDrivenMacro":{"description":"Workflow driven macro fileIds","type":"array","items":{"$ref":"#/definitions/WorkflowDrivenMacrosRequest"}},"policy":{"description":"Policy type to scan the website. Values are obtained by calling api/v3/lookup-items?type=DastAutomatedScanPolicies","enum":["Standard","CriticalsAndHighs","PassiveScan"],"type":"string"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"WorkflowDrivenMacrosRequest":{"required":["fileId","allowedHosts"],"type":"object","properties":{"fileId":{"format":"int32","description":"Workflow-driven macro file ID. Value is obtained by uploading workflow-driven macro","type":"integer"},"allowedHosts":{"description":"Hostname or IP address with port number. Value is obtained by uploading workflow-driven macro","type":"array","items":{"type":"string"}}}},"PutDastAutomatedOpenApiScanSetupRequest":{"required":["sourceType","sourceUrn","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"sourceType":{"description":"Specifies whether source is file ID or URL","enum":["FileId","Url"],"type":"string"},"sourceUrn":{"description":"File ID or URL","type":"string"},"apiKey":{"description":"API key","type":"string"},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"PutDastAutomatedGraphQLScanSetupRequest":{"required":["sourceType","sourceUrn","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"sourceType":{"description":"Specifies whether source is file ID or URL","enum":["FileId","Url"],"type":"string"},"sourceUrn":{"description":"File ID or URL","type":"string"},"schemeType":{"description":"Api scheme type (Http, Https, or HttpHttps)","type":"string"},"host":{"description":"API host name or IP address with port number","type":"string"},"servicePath":{"description":"Directory path for the API service","type":"string"},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"PutDastAutomatedGrpcScanSetupRequest":{"required":["fileId","schemeType","host","servicePath","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"fileId":{"format":"int32","description":"gRPC file ID. Value is obtained by uploading proto file","type":"integer"},"schemeType":{"description":"API scheme type (Http, Https, or HttpHttps)","type":"string"},"host":{"description":"API host name or IP address with port number","type":"string"},"servicePath":{"description":"Directory path for the API service","type":"string"},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"PutDastAutomatedPostmanScanSetupRequest":{"required":["collectionFileIds","assessmentTypeId","entitlementId","entitlementFrequencyType","dynamicScanEnvironmentFacingType","timeZone"],"type":"object","properties":{"collectionFileIds":{"description":"Postman collection file ID. Value is obtained by uploading Postman collection","type":"array","items":{"format":"int32","type":"integer"}},"timeBoxInHours":{"format":"int32","description":"Time limit in hours for Automated scan duration","type":"integer"},"assessmentTypeId":{"format":"int32","description":"Assessment type ID. Values are obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement ID. Values are obtained by calling GET /api/v3/tenant-entitlements","type":"integer"},"entitlementFrequencyType":{"description":"Entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"timeZone":{"description":"Timezone. Values are obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site, otherwise false","type":"boolean"},"networkAuthenticationSettings":{"$ref":"#/definitions/NetworkAuthenticationSettings","description":"Network authentication settings"},"requestFalsePositiveRemoval":{"description":"True if requesting one-time false positive removal, otherwise false","type":"boolean"},"networkName":{"type":"string"}}},"PatchDastAutomatedScanManifestResponse":{"type":"object","properties":{"fileId":{"format":"int32","type":"integer"},"hosts":{"type":"array","items":{"type":"string"}}}},"StartDastAutomatedScanResponse":{"description":"Start DAST Automated scan response","type":"object","properties":{"scanId":{"format":"int32","description":"The id of the scan that was started","type":"integer"}}},"PutDynamicScanSetupRequest":{"description":"PutDynamic Scan Setup Request","required":["geoLocationId","timeZone","entitlementFrequencyType"],"type":"object","properties":{"geoLocationId":{"format":"int32","description":"Geo Location Id of the scan. Values can be obtained by calling GET /api/v3/lookup-items?type=GeoLocations","type":"integer"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"exclusions":{"description":"Deprecated","type":"string"},"includeUrls":{"description":"List of subdomains.","type":"array","items":{"$ref":"#/definitions/Subdomain"}},"exclusionsList":{"description":"List of exclusions.","type":"array","items":{"$ref":"#/definitions/Exclusion"}},"dynamicScanAuthenticationType":{"description":"This field is obsolete. Please use the hasFormsAuthentication field to indicate if Forms Authentication is required to scan the site","enum":["NoAuthentication","GenerateUniqueAuthentication","AuthenticationRequired"],"type":"string"},"hasFormsAuthentication":{"description":"True if Forms Authentication is required to scan the site","type":"boolean"},"primaryUserName":{"description":"Primary username to login with","type":"string"},"primaryUserPassword":{"description":"Primary account password to login with","type":"string"},"secondaryUserName":{"description":"Secondary username to login with","type":"string"},"secondaryUserPassword":{"description":"Secondary account password to login with","type":"string"},"otherUserName":{"description":"Other username needed to operate the site","type":"string"},"otherUserPassword":{"description":"Other password needed to operate the site","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site","type":"boolean"},"networkUserName":{"description":"Network account username","type":"string"},"networkPassword":{"description":"Network account password","type":"string"},"notes":{"description":"Additional notes that will help with running a scan","type":"string"},"dynamicSiteURL":{"description":"The dynamic site url","type":"string"},"timeZone":{"description":"The timezone. Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"blockout":{"description":"Blockout days list. All days and hours will default to checked unless otherwise specified.","type":"array","items":{"$ref":"#/definitions/BlackoutDay"}},"repeatScheduleType":{"description":"For scans that are to be run at regular intervals, this specifies how often","enum":["NoRepeat","Biweekly","Monthly","Bimonthly","Quarterly","Triannually","Semiannually","Annually"],"type":"string"},"assessmentTypeId":{"format":"int32","description":"Assessment type identifier of the scan. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement identifier of the scan","type":"integer"},"allowFormSubmissions":{"description":"True to allow form submissions (default), otherwise false..","type":"boolean"},"restrictToDirectoryAndSubdirectories":{"description":"True to restrict to directory and subdirectories, otherwise false","type":"boolean"},"generateWAFVirtualPatch":{"description":"True to generate WAF virtual patch, otherwise false","type":"boolean"},"isWebService":{"description":"True if this a web service scan","type":"boolean"},"webServiceType":{"description":"The web service type","enum":["SOAP","REST","PostmanCollectionFile","PostmanCollectionURL","OpenApiFile","OpenApiUrl","Grpc","GraphQlFile","GraphQlUrl","PostmanAuthFile","PostmanEnvironmentFile","PostmanGlobalsFile"],"type":"string"},"webServiceDescriptorURL":{"description":"WSDL Location URL","type":"string"},"webServiceUserName":{"description":"The web service username","type":"string"},"webServicePassword":{"description":"The web service password","type":"string"},"webServiceAPIKey":{"description":"The web service API key","type":"string"},"webServiceAPIPassword":{"description":"The web service API password","type":"string"},"entitlementFrequencyType":{"description":"The entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"concurrentRequestThreadsType":{"description":"The concurrent request threads type","enum":["Standard","Limited"],"type":"string"},"postmanCollectionURL":{"description":"URL for the remote Postman collection manifest","type":"string"},"openApiURL":{"description":"URL for the remote OpenApi manifest","type":"string"},"remoteManifestAuthorizationHeaderName":{"description":"Optional header name for downloading a remote manifest (e.g. Postman, OpenApi)","type":"string"},"remoteManifestAuthorizationHeaderValue":{"description":"Optional header value for downloading a remote manifest (e.g. Postman, OpenApi)","type":"string"},"networkName":{"description":"When set indicates that the scan should use the specified Fortify on Demand Connect\r\nnetwork when running the scan. Scans that use a Fortify on Demand Connect network\r\nwill automatically set dynamicScanEnvironmentFacingType to 'Internal'. Fortify on\r\nDemand Connect must be enabled for this tenant to use this feature.","type":"string"},"graphqlUrl":{"description":"URL for the remote GraphQL manifest","type":"string"},"apiSchemeType":{"description":"Api scheme type (e.g. Http or Https or HttpHttps)","type":"string"},"apiHost":{"description":"Api host name or Ip address with port number","type":"string"},"apiServicePath":{"description":"Directory path for the API service","type":"string"},"twoFactorAuthentication":{"$ref":"#/definitions/PutTwoFactor","description":"Gets or sets the two-factor authentication settings"}}},"Subdomain":{"type":"object","properties":{"value":{"description":"URL subdomain to include in scanning.","type":"string"}}},"BlackoutDay":{"description":"Blockout day option","type":"object","properties":{"day":{"description":"Day of week the hour blocks are associated with","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"hourBlocks":{"description":"The list of hours and their blockout states","type":"array","items":{"$ref":"#/definitions/BlackoutHour"}}}},"PutTwoFactor":{"type":"object","properties":{"hasTwoFactorAuthentication":{"default":false,"type":"boolean"},"twoFactorAuthenticationType":{"enum":["Email","TOTP"],"type":"string"},"primaryUserTwoFactorEmail":{"type":"string"},"secondaryUserTwoFactorEmail":{"type":"string"},"otherUserTwoFactorEmail":{"type":"string"},"primaryUserTotpSecret":{"type":"string"},"secondaryUserTotpSecret":{"type":"string"},"otherUserTotpSecret":{"type":"string"},"otherTwoFactorUsers":{"type":"array","items":{"$ref":"#/definitions/PutOtherTwoFactorUser"}}}},"BlackoutHour":{"description":"Blockout hour option","type":"object","properties":{"hour":{"format":"int32","description":"The 24 hour identifier (0-23)","type":"integer"},"checked":{"description":"Checked is true when this hour is blocked out. It is false when clear to scan","type":"boolean"}}},"PutOtherTwoFactorUser":{"type":"object","properties":{"totpSecret":{"type":"string"},"userPassword":{"type":"string"},"userIndex":{"format":"int32","default":1,"type":"integer"},"twoFactorEmail":{"type":"string"},"userName":{"type":"string"}}},"PutDynamicScanSetupResponse":{"description":"Put Dynamic Scan Setup Response","type":"object","properties":{"success":{"description":"Indicates if the mobile scan was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"GetDynamicScanSetupResponse":{"description":"GetDynamicScanSetupResponse","required":["geoLocationId","timeZone","entitlementFrequencyType"],"type":"object","properties":{"webServiceManifestFiles":{"description":"Collection of manifest files for web services","type":"array","items":{"$ref":"#/definitions/WebServiceManifestFile"}},"scanDocument":{"description":"Collection of scan document and additional details files","type":"array","items":{"$ref":"#/definitions/ScanDocument"}},"geoLocationId":{"format":"int32","description":"Geo Location Id of the scan. Values can be obtained by calling GET /api/v3/lookup-items?type=GeoLocations","type":"integer"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"exclusions":{"description":"Deprecated","type":"string"},"includeUrls":{"description":"List of subdomains.","type":"array","items":{"$ref":"#/definitions/Subdomain"}},"exclusionsList":{"description":"List of exclusions.","type":"array","items":{"$ref":"#/definitions/Exclusion"}},"dynamicScanAuthenticationType":{"description":"This field is obsolete. Please use the hasFormsAuthentication field to indicate if Forms Authentication is required to scan the site","enum":["NoAuthentication","GenerateUniqueAuthentication","AuthenticationRequired"],"type":"string"},"hasFormsAuthentication":{"description":"True if Forms Authentication is required to scan the site","type":"boolean"},"primaryUserName":{"description":"Primary username to login with","type":"string"},"primaryUserPassword":{"description":"Primary account password to login with","type":"string"},"secondaryUserName":{"description":"Secondary username to login with","type":"string"},"secondaryUserPassword":{"description":"Secondary account password to login with","type":"string"},"otherUserName":{"description":"Other username needed to operate the site","type":"string"},"otherUserPassword":{"description":"Other password needed to operate the site","type":"string"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site","type":"boolean"},"networkUserName":{"description":"Network account username","type":"string"},"networkPassword":{"description":"Network account password","type":"string"},"notes":{"description":"Additional notes that will help with running a scan","type":"string"},"dynamicSiteURL":{"description":"The dynamic site url","type":"string"},"timeZone":{"description":"The timezone. Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"blockout":{"description":"Blockout days list. All days and hours will default to checked unless otherwise specified.","type":"array","items":{"$ref":"#/definitions/BlackoutDay"}},"repeatScheduleType":{"description":"For scans that are to be run at regular intervals, this specifies how often","enum":["NoRepeat","Biweekly","Monthly","Bimonthly","Quarterly","Triannually","Semiannually","Annually"],"type":"string"},"assessmentTypeId":{"format":"int32","description":"Assessment type identifier of the scan. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"Entitlement identifier of the scan","type":"integer"},"allowFormSubmissions":{"description":"True to allow form submissions (default), otherwise false..","type":"boolean"},"restrictToDirectoryAndSubdirectories":{"description":"True to restrict to directory and subdirectories, otherwise false","type":"boolean"},"generateWAFVirtualPatch":{"description":"True to generate WAF virtual patch, otherwise false","type":"boolean"},"isWebService":{"description":"True if this a web service scan","type":"boolean"},"webServiceType":{"description":"The web service type","enum":["SOAP","REST","PostmanCollectionFile","PostmanCollectionURL","OpenApiFile","OpenApiUrl","Grpc","GraphQlFile","GraphQlUrl","PostmanAuthFile","PostmanEnvironmentFile","PostmanGlobalsFile"],"type":"string"},"webServiceDescriptorURL":{"description":"WSDL Location URL","type":"string"},"webServiceUserName":{"description":"The web service username","type":"string"},"webServicePassword":{"description":"The web service password","type":"string"},"webServiceAPIKey":{"description":"The web service API key","type":"string"},"webServiceAPIPassword":{"description":"The web service API password","type":"string"},"entitlementFrequencyType":{"description":"The entitlement frequency type","enum":["SingleScan","Subscription"],"type":"string"},"concurrentRequestThreadsType":{"description":"The concurrent request threads type","enum":["Standard","Limited"],"type":"string"},"postmanCollectionURL":{"description":"URL for the remote Postman collection manifest","type":"string"},"openApiURL":{"description":"URL for the remote OpenApi manifest","type":"string"},"remoteManifestAuthorizationHeaderName":{"description":"Optional header name for downloading a remote manifest (e.g. Postman, OpenApi)","type":"string"},"remoteManifestAuthorizationHeaderValue":{"description":"Optional header value for downloading a remote manifest (e.g. Postman, OpenApi)","type":"string"},"networkName":{"description":"When set indicates that the scan should use the specified Fortify on Demand Connect\r\nnetwork when running the scan. Scans that use a Fortify on Demand Connect network\r\nwill automatically set dynamicScanEnvironmentFacingType to 'Internal'. Fortify on\r\nDemand Connect must be enabled for this tenant to use this feature.","type":"string"},"graphqlUrl":{"description":"URL for the remote GraphQL manifest","type":"string"},"apiSchemeType":{"description":"Api scheme type (e.g. Http or Https or HttpHttps)","type":"string"},"apiHost":{"description":"Api host name or Ip address with port number","type":"string"},"apiServicePath":{"description":"Directory path for the API service","type":"string"},"twoFactorAuthentication":{"$ref":"#/definitions/GetTwoFactor","description":"Gets or sets the two-factor authentication settings for the GET response."}}},"WebServiceManifestFile":{"type":"object","properties":{"webServiceFileType":{"description":"The web service type","enum":["Postman","OpenApi","GraphQL","Grpc","WSDL"],"type":"string"},"filename":{"description":"The name of the manifest file","type":"string"},"dateCreated":{"format":"date-time","description":"The creation date of the manifest file","type":"string"},"fileId":{"description":"The id of the manifest file","type":"string"},"postmanFileType":{"description":"The type of Postman file (Workflow, Auth, Environment, or Globals). \r\nNull for non-Postman web service types.","enum":["Workflow","Auth","Environment","Globals"],"type":"string"}}},"ScanDocument":{"type":"object","properties":{"fileId":{"format":"int32","description":"The id of the scan document and additional details files","type":"integer"},"fileName":{"description":"The name of the scan document and additional details files","type":"string"},"createdDate":{"description":"The creation date of the scan document and additional details files","type":"string"}}},"GetTwoFactor":{"type":"object","properties":{"hasTwoFactorAuthentication":{"default":false,"type":"boolean"},"twoFactorAuthenticationType":{"enum":["Email","TOTP"],"type":"string"},"primaryUserTwoFactorEmail":{"type":"string"},"secondaryUserTwoFactorEmail":{"type":"string"},"otherUserTwoFactorEmail":{"type":"string"},"primaryUserHasTotpConfigured":{"default":false,"type":"boolean"},"secondaryUserHasTotpConfigured":{"default":false,"type":"boolean"},"otherUserHasTotpConfigured":{"default":false,"type":"boolean"},"otherTwoFactorUsers":{"type":"array","items":{"$ref":"#/definitions/GetOtherTwoFactorUser"}}}},"GetOtherTwoFactorUser":{"type":"object","properties":{"hasTotpConfigured":{"default":false,"type":"boolean"},"userIndex":{"format":"int32","default":1,"type":"integer"},"twoFactorEmail":{"type":"string"},"userName":{"type":"string"}}},"PatchDynamicScanSetupManifestResponse":{"type":"object","properties":{"success":{"description":"Indicates if the mobile scan was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}},"fileId":{"type":"string"}}},"StartDynamicScanRequest":{"description":"Options for starting the scan","required":["startDate","assessmentTypeId","entitlementId","entitlementFrequencyType","isRemediationScan"],"type":"object","properties":{"startDate":{"format":"date-time","description":"Date when the scan should start, in MM/dd/yyyy HH:mm format","type":"string"},"assessmentTypeId":{"format":"int32","description":"The assessment type id to use for the scan. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"The entitlement id to consume for the scan","type":"integer"},"entitlementFrequencyType":{"description":"The entitlement frequency type to use for the scan","enum":["SingleScan","Subscription"],"type":"string"},"isRemediationScan":{"description":"Indicates if the scan is a remediation scan. If not supplied the default value is false","type":"boolean"},"isBundledAssessment":{"description":"Indicates if the assessment is a bundled assessment. If not supplied legacy behavior will apply","type":"boolean"},"parentAssessmentTypeId":{"format":"int32","description":"The parent assessment type id for the bundled assessment. If not supplied legacy behavior will apply","type":"integer"},"applyPreviousScanSettings":{"description":"Indicates if the previous scan settings should be applied to the remediation scan. This value is ignored if isRemediationScan = false. If not supplied the default value is false.","type":"boolean"},"scanMethodType":{"description":"The method of starting a scan","enum":["IDE","CICD","Other","API"],"type":"string"},"scanTool":{"description":"The tool used for scanning","type":"string"},"scanToolVersion":{"description":"The version for the scan tool used for scanning","type":"string"}}},"StartDynamicScanResponse":{"description":"Start dynamic scan response","type":"object","properties":{"scanId":{"format":"int32","description":"The id of the scan that was started","type":"integer"}}},"PutImportScanResponse":{"description":"PutImportScanResponse","type":"object","properties":{"referenceId":{"description":"Reference Id","type":"string"},"scanId":{"format":"int32","description":"The scan id","type":"integer"}}},"PutDynamicToDastAutomatedResponse":{"type":"object","properties":{"success":{"description":"Indicates Success response","type":"boolean"},"message":{"description":"Details about the initiation of DAST automated scans.","type":"string"}}},"ParseTotpQrResponse":{"type":"object","properties":{"totpSecret":{"type":"string"}}},"FortifyConnectApiNetworkListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/FortifyConnectApiNetwork"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"FortifyConnectApiNetwork":{"type":"object","properties":{"networkName":{"type":"string"},"userName":{"type":"string"}}},"LookupItemListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/LookupItem"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"LookupItem":{"description":"Lookup Item","type":"object","properties":{"value":{"description":"The value property","type":"string"},"text":{"description":"The text property","type":"string"},"group":{"description":"The group property","type":"string"}}},"MobileScanSetup":{"description":"StaticScanSetup","type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The AssessmentTypeId. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"The assigned entitlementId","type":"integer"},"entitlementFrequencyType":{"description":"The EntitlementFrequencyType.","enum":["SingleScan","Subscription"],"type":"string"},"frameworkType":{"description":"The framework type","type":"string"},"auditPreferenceType":{"description":"The AuditPreferenceType.","type":"string"},"timeZone":{"description":"The timeZone.","type":"string"}}},"PutMobileScanSetupRequest":{"description":"Put Mobile Scan Setup Request","required":["assessmentTypeId","frameworkType","timeZone"],"type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The assessment type id. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"frameworkType":{"description":"The framework type","enum":["iOS","Android"],"type":"string"},"timeZone":{"description":"The timezone. Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"userAccountsRequried":{"description":"Indicates if user accounts are required","type":"boolean"},"userAccounts":{"description":"List of user accounts","type":"array","items":{"$ref":"#/definitions/MobileScanUserAccount"}},"notes":{"description":"Notes","type":"string"},"vpnRequired":{"description":"Indicates if VPN is required","type":"boolean"},"vpnUserName":{"description":"The VPN username","type":"string"},"vpnPassword":{"description":"The VPN password","type":"string"},"hasMultiFactorAuthentication":{"description":"Indicates if multi-factor authentication is used","type":"boolean"},"multiFactorAuthenticationNotes":{"description":"Multi-factor authentication notes","type":"string"},"intrusionDetectionSystem":{"description":"Indicates if intrusion detection system is used","type":"boolean"},"intrusionPreventionSystem":{"description":"Indicates if intrusion prevention system is used","type":"boolean"},"webApplicationFirewall":{"description":"Indicates if web application firewall is used","type":"boolean"},"proxyServers":{"description":"Indicates if proxy servers are used","type":"boolean"},"loadBalancer":{"description":"Indicates if load balancer is used","type":"boolean"},"preAssessmentCall":{"description":"Indicates if the customer should be contacted prior to beginning the assessment","type":"boolean"},"auditPreferenceType":{"description":"The audit preference type","enum":["Manual","None"],"type":"string"}}},"MobileScanUserAccount":{"description":"Mobile Scan User Account","type":"object","properties":{"username":{"description":"The username","type":"string"},"password":{"description":"The password","type":"string"},"roleType":{"description":"The role type","enum":["User","Guest","Admin","Other"],"type":"string"},"oneTimePassword":{"description":"The one time password","type":"string"}}},"PutMobileScanSetupResponse":{"description":"Put Mobile Scan Setup Response","type":"object","properties":{"success":{"description":"Indicates if the mobile scan was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PostMobileScanResponse":{"description":"Post Mobile Scan Response","type":"object","properties":{"scanId":{"format":"int32","description":"The id of the scan that was created","type":"integer"}}},"PostMultiFactorAuthorizationCodeRequest":{"description":"Post Multi Factor Authorization Code Request","required":["multiFactorAuthorizationType","username","password"],"type":"object","properties":{"multiFactorAuthorizationType":{"description":"Type of Authorization (sms or email)","enum":["SMSDelivery","EmailDelivery"],"type":"string"},"username":{"description":"Tenant Code / Username","type":"string"},"password":{"description":"Password","type":"string"}}},"NotificationListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Notification"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"Notification":{"description":"Notification","type":"object","properties":{"messageId":{"format":"int32","description":"The message id","type":"integer"},"subject":{"description":"The subject","type":"string"},"message":{"description":"The message","type":"string"},"triggerType":{"description":"The NotificationTriggerType. Values can be obtained by calling GET /api/v3/lookup-items?type=NotificationTriggerTypes","type":"string"},"triggerTypeId":{"format":"int32","description":"The NotificationTriggerType id. Values can be obtained by calling GET /api/v3/lookup-items?type=NotificationTriggerTypes","type":"integer"},"createdDate":{"format":"date-time","description":"The created date","type":"string"},"read":{"description":"Indicates if the message has been marked read","type":"boolean"}}},"MarkNotificaitonsAsReadRequest":{"required":["messageIds"],"type":"object","properties":{"messageIds":{"description":"The list of message ids to mark as read","type":"array","items":{"format":"int32","type":"integer"}}}},"OpenSourceComponentListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/OpenSourceComponent"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"OpenSourceComponent":{"type":"object","properties":{"componentHash":{"type":"string"},"componentName":{"type":"string"},"componentVersionName":{"type":"string"},"licenses":{"type":"array","items":{"$ref":"#/definitions/OpenSourceComponentLicense"}},"vulnerabilityCounts":{"type":"array","items":{"$ref":"#/definitions/VulnerabilityCount"}},"releases":{"type":"array","items":{"$ref":"#/definitions/OpenSourceComponentRelease"}},"packageUrl":{"type":"string"},"scanTool":{"type":"string"}}},"OpenSourceComponentLicense":{"type":"object","properties":{"name":{"type":"string"}}},"VulnerabilityCount":{"type":"object","properties":{"severityId":{"format":"int32","type":"integer","readOnly":true},"severity":{"type":"string","readOnly":true},"count":{"format":"int32","type":"integer"}}},"OpenSourceComponentRelease":{"type":"object","properties":{"applicationId":{"format":"int32","type":"integer"},"applicationName":{"type":"string"},"releaseId":{"format":"int32","type":"integer"},"releaseName":{"type":"string"}}},"PostStartScanResponse":{"description":"Post Start Scan Response","type":"object","properties":{"scanId":{"format":"int32","description":"The id of the scan that was created","type":"integer"},"messages":{"description":"List of informational messages","type":"array","items":{"type":"string"}},"legalMessage":{"description":"Legal Disclaimer Message","type":"string"}}},"PutPersonalAccessTokenRequest":{"type":"object","properties":{"name":{"description":"The name of the personal access token","type":"string"},"isAuthorized":{"description":"Flag indicating if the token is authorized to use the API","type":"boolean"},"allowedScopes":{"description":"Comma delimited list of tenant API scopes the token can be used for","type":"string"}}},"PersonalAccessTokenModel":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"isAuthorized":{"type":"boolean"},"secretExpirationDate":{"format":"date-time","type":"string"},"secretLifetimeDays":{"format":"int32","type":"integer"},"allowedScopes":{"type":"string"},"lastSuccessfulLoginDate":{"format":"date-time","type":"string"},"lastSuccessfulLoginIpAddress":{"type":"string"},"userId":{"format":"int32","type":"integer"},"userName":{"type":"string"}}},"PostPersonalAccessTokenRequest":{"required":["name","isAuthorized","allowedScopes"],"type":"object","properties":{"name":{"description":"The name of the personal access token","type":"string"},"isAuthorized":{"description":"Flag indicating if the token is authorized to use the API","type":"boolean"},"allowedScopes":{"description":"Comma delimited list of tenant API scopes the token can be used for","type":"string"},"secretLifetimeDays":{"format":"int32","description":"Number of days the token's secret is valid for","type":"integer"},"secretExpirationDate":{"format":"date-time","description":"Date in MM/dd/yyyy format on which the secret should expire and after which will no longer be valid","type":"string"}}},"CreatePersonalAccessTokenResult":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"secret":{"type":"string"}}},"PersonalAccessTokenModelListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/PersonalAccessTokenModel"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"PutPersonalAccessTokenSecretRequest":{"type":"object","properties":{"secretLifetimeDays":{"format":"int32","description":"Number of days the token's secret is valid for","type":"integer"},"secretExpirationDate":{"format":"date-time","description":"Date in MM/dd/yyyy format on which the secret should expire and after which will no longer be valid","type":"string"}}},"PutReleaseRequest":{"description":"Put Release Request","required":["releaseName","sdlcStatusType"],"type":"object","properties":{"releaseName":{"description":"The release name","type":"string"},"releaseDescription":{"description":"The release description","type":"string"},"sdlcStatusType":{"description":"The release SDLC status type","enum":["Production","QA","Development","Retired"],"type":"string"},"ownerId":{"format":"int32","description":"The owner id for the release","type":"integer"},"microserviceId":{"format":"int32","description":"The ID of the microservice","type":"integer"},"attributes":{"description":"Release attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}}}},"PutReleaseResponse":{"description":"Put Release Response","type":"object","properties":{"success":{"description":"Indicates if the release was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"DeleteReleaseResponse":{"description":"Delete Release Response","type":"object","properties":{"success":{"description":"Indicates if the release was deleted","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PostReleaseRequest":{"description":"Post Release Request","required":["applicationId","releaseName","sdlcStatusType"],"type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"releaseName":{"description":"The release name","type":"string"},"releaseDescription":{"description":"The release description","type":"string"},"copyState":{"description":"Indicates if copy state is used","type":"boolean"},"copyStateReleaseId":{"format":"int32","description":"The release id to use if CopyState is trueS","type":"integer"},"sdlcStatusType":{"description":"The release SDLC status type","enum":["Production","QA","Development","Retired"],"type":"string"},"microserviceId":{"format":"int32","description":"The id of the Microservice to be associated with this version","type":"integer"},"attributes":{"description":"Release attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}}}},"PostReleaseResponse":{"description":"Post Release Response","type":"object","properties":{"releaseId":{"format":"int32","description":"The id of the release that was created","type":"integer"},"success":{"description":"Indicates if the application was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PollingScanSummary":{"type":"object","properties":{"ScanId":{"format":"int32","type":"integer"},"OpenSourceScanId":{"format":"int32","type":"integer"},"TenantId":{"format":"int32","type":"integer"},"AnalysisStatusId":{"format":"int32","type":"integer"},"OpenSourceStatusId":{"format":"int32","type":"integer"},"QueuePositionWithinApplication":{"format":"int32","type":"integer"},"AnalysisStatusTypeValue":{"type":"string"},"AnalysisStatusReasonId":{"format":"int32","type":"integer"},"AnalysisStatusReason":{"type":"string"},"AnalysisStatusReasonNotes":{"type":"string"},"IssueCountCritical":{"format":"int32","type":"integer"},"IssueCountHigh":{"format":"int32","type":"integer"},"IssueCountMedium":{"format":"int32","type":"integer"},"IssueCountLow":{"format":"int32","type":"integer"},"PassFailStatus":{"type":"boolean"},"PassFailReasonType":{"type":"string"},"PauseDetails":{"type":"array","items":{"$ref":"#/definitions/ScanPauseDetailPolling"}},"ScanType":{"format":"int32","type":"integer"}}},"ScanPauseDetailPolling":{"type":"object","properties":{"Reason":{"type":"string"},"Notes":{"type":"string"}}},"CategoryRollupsResponse":{"description":"Category Rollups Response","type":"object","properties":{"items":{"description":"List of category count items","type":"array","items":{"$ref":"#/definitions/CategoryCount"}}}},"CategoryCount":{"description":"Category Count","type":"object","properties":{"category":{"description":"The category name","type":"string"},"count":{"format":"int32","description":"The count for the category","type":"integer"}}},"PostAuditActionRequest":{"description":"Post Audit Action Request","required":["auditAction"],"type":"object","properties":{"auditAction":{"description":"The audit action","enum":["Cancel","Start","Submit"],"type":"string"}}},"GetAuditOptionsResponse":{"description":"Get Audit Options Response","type":"object","properties":{"releaseId":{"format":"int32","description":"The release id","type":"integer"},"auditProcessing":{"description":"Indicates if an audit is current processing","type":"boolean"},"canAudit":{"description":"Indicates if the user can audit","type":"boolean"},"canChallenge":{"description":"Indicates if the user can challenge","type":"boolean"},"canEdit":{"description":"Indicates if the user can edit","type":"boolean"},"inAuditMode":{"description":"Indicates if the release is in audit mode","type":"boolean"}}},"GetStaticScanOptionsResponse":{"description":"Get Static Scan Options Response","type":"object","properties":{"items":{"description":"List of scan option items","type":"array","items":{"$ref":"#/definitions/ScanOption"}}}},"ScanOption":{"description":"Scan Option","type":"object","properties":{"id":{"format":"int32","description":"The scan option id","type":"integer"},"name":{"description":"The scan option name","type":"string"},"lastSelectedOption":{"description":"The last selected option","type":"string"},"options":{"description":"List of options","type":"array","items":{"$ref":"#/definitions/LookupItem"}}}},"ReleaseAssessmentTypeListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/ReleaseAssessmentType"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"ReleaseAssessmentType":{"description":"Release Assessment Type","type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The assessment type id. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"name":{"description":"The assessment type name","type":"string"},"scanType":{"description":"The scan type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"string"},"scanTypeId":{"format":"int32","description":"The scan type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"integer"},"entitlementId":{"format":"int32","description":"The entitlement id. -1 indicates the assessment type is available for purchase","type":"integer"},"frequencyType":{"description":"The entitlement frequency type id","type":"string"},"frequencyTypeId":{"format":"int32","description":"The entitlement frequency type id","type":"integer"},"units":{"format":"int32","description":"The number of units the scan will consume","type":"integer"},"unitsAvailable":{"format":"int32","description":"The number of units available","type":"integer"},"subscriptionEndDate":{"format":"date-time","description":"The subscription end date for the entitlement","type":"string"},"isRemediation":{"description":"Indicates if a remediation scan is available for the assessment type","type":"boolean"},"remediationScansAvailable":{"format":"int32","description":"The number of remediation scans available for the release and assessment type","type":"integer"},"isBundledAssessment":{"description":"Indicates if the assessment type is a bundled assessment","type":"boolean"},"parentAssessmentTypeId":{"format":"int32","description":"The parent assessment type id for the bundled assessment","type":"integer"},"parentAssessmentTypeName":{"description":"The parent assessment type name","type":"string"},"parentAssessmentTypeScanType":{"description":"The parent assessment type scan type name","type":"string"},"parentAssessmentTypeScanTypeId":{"format":"int32","description":"The parent assessment type scan type id","type":"integer"},"entitlementDescription":{"description":"The entitlement description","type":"string"},"assessmentCategory":{"type":"string"}}},"GetImportScanSessionIdResponse":{"description":"Get Import Scan Session Id Response","type":"object","properties":{"importScanSessionId":{"description":"The unique importId to use for the session","type":"string"}}},"PostCancelScanResponse":{"description":"Post Cancel Scan Response","type":"object","properties":{"success":{"description":"Indicates if the request was successful","type":"boolean"},"message":{"description":"Message returned for the request","type":"string"}}},"GetStaticScanBSITokenResponse":{"description":"Get Static Scan BSI Token Response","type":"object","properties":{"bsiToken":{"description":"The build server integration token","type":"string"}}},"Report":{"description":"Report","type":"object","properties":{"reportId":{"format":"int32","description":"The report id","type":"integer"},"reportName":{"description":"The report name","type":"string"},"reportNotes":{"description":"The report notes","type":"string"},"reportStatusTypeId":{"format":"int32","description":"The report status type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ReportStatusType","type":"integer"},"reportStatusType":{"description":"The report status type. Values can be obtained by calling GET /api/v3/lookup-items?type=ReportStatusType","type":"string"},"reportTypeId":{"format":"int32","description":"The report type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ReportTypes","type":"integer"},"reportType":{"description":"The report type. Values can be obtained by calling GET /api/v3/lookup-items?type=ReportTypes","type":"string"},"customReportTypeName":{"description":"The custom report type name","type":"string"},"isReceived":{"description":"Is received","type":"boolean"},"language":{"description":"The report language","type":"string"},"applicationId":{"format":"int32","description":"The application id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"},"userId":{"format":"int32","description":"The user id","type":"integer"}}},"DeleteReportResponse":{"description":"Delete Application Response","type":"object","properties":{"success":{"description":"Indicates if the report was deleted","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"ReportListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/Report"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"PostReportRequest":{"description":"Post Report Request","required":["applicationId","releaseId","reportTemplateTypeId","reportFormat"],"type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"},"reportTemplateTypeId":{"format":"int32","description":"The report template type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ReportTemplateTypes","type":"integer"},"reportName":{"description":"The report name","type":"string"},"reportFormat":{"description":"The report format","enum":["Pdf","Html"],"type":"string"},"notes":{"description":"The report notes","type":"string"}}},"PostReportResponse":{"description":"Post Report Response","type":"object","properties":{"reportId":{"format":"int32","description":"The id of the report that was created","type":"integer"},"success":{"description":"Indicates if the application was created","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"DataExportListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/DataExport"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"DataExport":{"description":"DataExport","type":"object","properties":{"dataExportId":{"format":"int32","description":"The data export id","type":"integer"},"dataExportName":{"description":"The data export name","type":"string"},"dataExportType":{"description":"The data export type","enum":["IssuesExport","ScansExport","ReleasesExport","ApplicationsExport","EntitlementConsumptionExport"],"type":"string"},"createdBy":{"description":"The username that created the data export","type":"string"},"createdDate":{"format":"date-time","description":"The created date","type":"string"},"dataExportStatusType":{"description":"The data export status type","enum":["Started","Completed","Failed","Queued","Canceled"],"type":"string"}}},"PostDataExportRequest":{"description":"Request model for creating a new data export","type":"object","properties":{"dataExportTemplateId":{"format":"int32","description":"The data export template id","type":"integer"}}},"PostDataExportResponse":{"description":"Response model for creating a new data export","type":"object","properties":{"dataExportId":{"format":"int32","description":"The data export id","type":"integer"},"links":{"$ref":"#/definitions/DataExportLinks","description":"Links for tracking and downloading the export"}}},"DataExportLinks":{"description":"Links for data export","type":"object","properties":{"status":{"description":"URL for checking the status of the data export","type":"string"},"download":{"description":"URL for downloading the completed data export","type":"string"}}},"DataExportTemplateListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/DataExportTemplate"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"DataExportTemplate":{"description":"DataExportTemplate","type":"object","properties":{"dataExportTemplateId":{"format":"int32","description":"The data export template id","type":"integer"},"dataExportTemplateName":{"description":"The data export template name","type":"string"},"dataExportTemplateType":{"description":"The data export template type","enum":["IssuesExport","ScansExport","ReleasesExport","ApplicationsExport","EntitlementConsumptionExport"],"type":"string"}}},"ScanSummary":{"description":"ScanSummary","type":"object","properties":{"startedByUserId":{"format":"int32","description":"The id of the user that started the scan","type":"integer"},"startedByUserName":{"description":"The user name of the user that started the scan","type":"string"},"dynamicScanSummaryDetails":{"$ref":"#/definitions/DynamicScanSummaryDetails","description":"DynamicScanSummaryDetails"},"mobileScanSummaryDetails":{"$ref":"#/definitions/MobileScanSummaryDetails","description":"MobileScanSummaryDetails"},"staticScanSummaryDetails":{"$ref":"#/definitions/StaticScanSummaryDetails","description":"StaticScanSummaryDetails"},"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The application name","type":"string"},"releaseId":{"format":"int32","description":"The release id","type":"integer"},"releaseName":{"description":"The release name","type":"string"},"scanId":{"format":"int32","description":"The scan id","type":"integer"},"scanTypeId":{"format":"int32","description":"The scan type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"integer"},"scanType":{"description":"The scan type. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"string"},"assessmentTypeId":{"format":"int32","description":"The assessment type id. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"assessmentTypeName":{"description":"The assessment type name. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"string"},"analysisStatusTypeId":{"format":"int32","description":"The analysis status type id. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"integer"},"analysisStatusType":{"description":"The analysis status type. Values can be obtained by calling GET /api/v3/lookup-items?type=AnalysisStatusTypes","type":"string"},"startedDateTime":{"format":"date-time","description":"The scan started date time","type":"string"},"completedDateTime":{"format":"date-time","description":"The scan completed date time","type":"string"},"totalIssues":{"format":"int32","description":"Total number of issues","type":"integer"},"issueCountCritical":{"format":"int32","description":"Total number of critical issues","type":"integer"},"issueCountHigh":{"format":"int32","description":"Total number of high issues","type":"integer"},"issueCountMedium":{"format":"int32","description":"Total number of medium issues","type":"integer"},"issueCountLow":{"format":"int32","description":"Total number of low issues","type":"integer"},"starRating":{"format":"int32","description":"The star rating","type":"integer"},"notes":{"description":"Scan notes","type":"string"},"isFalsePositiveChallenge":{"description":"Indicates if the scan is a false positive challenge","type":"boolean"},"isRemediationScan":{"description":"Indicates if the scan is a remediation scan","type":"boolean"},"entitlementId":{"format":"int32","description":"The entitlement id used for the given scan","type":"integer"},"entitlementUnitsConsumed":{"format":"int32","description":"The number of entitlement units used for the given scan","type":"integer"},"isSubscriptionEntitlement":{"description":"Indicates if the entitlement used for the given scan is a subscription entitlement","type":"boolean"},"pauseDetails":{"description":"The details for each time the scan has been paused/resumed.","type":"array","items":{"$ref":"#/definitions/ScanPauseDetail"}},"cancelReason":{"description":"Cancel Reason","type":"string"},"analysisStatusReasonNotes":{"description":"The Analysis Status Reason Notes","type":"string"},"scanMethodTypeId":{"format":"int32","description":"The scan method type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanMethodTypes","type":"integer"},"scanMethodTypeName":{"description":"The scan method type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanMethodTypes","type":"string"},"scanPolicyTypeId":{"format":"int32","description":"The scan policy type id. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanPolicyTypes","type":"integer"},"scanPolicyTypeName":{"description":"The scan policy type name. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanPolicyTypes","type":"string"},"scanTool":{"description":"The tool used for scanning","type":"string"},"scanToolVersion":{"description":"The version for the scan tool used for scanning","type":"string"},"attributes":{"description":"Scan attributes","type":"array","items":{"$ref":"#/definitions/ApplicationAttributeExtended"}}}},"DynamicScanSummaryDetails":{"type":"object","properties":{"dynamicSiteURL":{"description":"The dynamic site url","type":"string"},"restrictToDirectoryAndSubdirectories":{"description":"True to restrict to directory and subdirectories, otherwise false","type":"boolean"},"allowSameHostRedirects":{"description":"True to allow HTTP (:80) and HTTPS (:443) of the specified scan host (default), otherwise false.","type":"boolean"},"allowFormSubmissions":{"description":"True to allow form submissions (default), otherwise false..","type":"boolean"},"timeZone":{"description":"The timezone. Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"},"dynamicScanEnvironmentFacingType":{"description":"Type of environment the server is running in","enum":["Internal","External"],"type":"string"},"hasAvailabilityRestrictions":{"description":"Indicates if there are any availability restrictions","type":"boolean"},"requestCall":{"description":"True if client requests a call prior to assessment","type":"boolean"},"hasFormsAuthentication":{"description":"True if Forms Authentication is required to scan the site","type":"boolean"},"requiresNetworkAuthentication":{"description":"True if network connection is required to scan the site","type":"boolean"},"isWebService":{"description":"True if this a web service scan","type":"boolean"},"webServiceType":{"description":"The web service type","enum":["SOAP","REST","PostmanCollectionFile","PostmanCollectionURL","OpenApiFile","OpenApiUrl","Grpc","GraphQlFile","GraphQlUrl","PostmanAuthFile","PostmanEnvironmentFile","PostmanGlobalsFile"],"type":"string"},"userAgentType":{"description":"The user agent type","enum":["Desktop","Mobile"],"type":"string"},"notes":{"description":"Additional notes that will help with running a scan","type":"string"},"concurrentRequestThreadsType":{"description":"The concurrent request threads type","enum":["Standard","Limited"],"type":"string"},"elapsedTimeSpan":{"description":"The Elapsed Time Scan Span","type":"string"},"policyName":{"description":"WebInspect Policy","type":"string"},"crawlSessions":{"format":"int32","description":"Crawl Sessions","type":"integer"},"failedRequests":{"format":"int32","description":"Network Failed Requests","type":"integer"},"logouts":{"format":"int32","description":"Network Logouts","type":"integer"},"macroPlaybacks":{"format":"int32","description":"Network Macro Playbacks","type":"integer"},"scanType":{"description":"The DAST Automated scan type. Values can be obtained by calling GET /api/v3/lookup-items?type=DastAutomatedScanTypes","type":"string"},"timeBoxInHours":{"format":"int32","type":"integer"}}},"MobileScanSummaryDetails":{"type":"object","properties":{"frameworkType":{"description":"The framework type","enum":["iOS","Android"],"type":"string"},"auditPreferenceType":{"description":"The audit preference type","enum":["Manual","Automated"],"type":"string"},"platformType":{"description":"The platform type","enum":["Phone","Tablet","Both"],"type":"string"},"identifier":{"description":"Identifier","type":"string"},"version":{"description":"Version","type":"string"},"userAccountsRequried":{"description":"Indicates if user accounts are required","type":"boolean"},"accessToWebServices":{"description":"Indicates if there is access to web services","type":"boolean"},"hasExclusions":{"description":"Indicates if there are any exclusions","type":"boolean"},"hasAvailabilityRestrictions":{"description":"Indicates if there are any availability restrictions","type":"boolean"}}},"StaticScanSummaryDetails":{"type":"object","properties":{"technologyStack":{"description":"The technology stack","type":"string"},"languageLevel":{"description":"The language level","type":"string"},"doSonatypeScan":{"description":"Indicates if a sonatype scan should be included","type":"boolean"},"auditPreferenceType":{"description":"The audit preference type","enum":["Manual","Automated"],"type":"string"},"excludeThirdPartyLibs":{"description":"Indicates if third party libraries should be excluded","type":"boolean"},"buildDate":{"format":"date-time","description":"The build date","type":"string"},"engineVersion":{"description":"The engine version","type":"string"},"rulePackVersion":{"description":"The rule pack version","type":"string"},"fileCount":{"format":"int32","description":"The file count","type":"integer"},"totalLinesOfCode":{"format":"int32","description":"The total lines of code","type":"integer"},"payLoadSize":{"description":"The size in KB of the payload","type":"string"},"staticVulnerabilityFilter":{"description":"The selected Static Vulnerability Filter","type":"string"},"includeFortifyAviator":{"description":"Indicates whether Aviator Addon Service is enabled","type":"boolean"},"fortifyAviatorError":{"$ref":"#/definitions/FortifyAviatorError","description":"Aviator information on validation error and exit error code"},"scanPolicy":{"description":"The selected Static Vulnerability Filter","type":"string"}}},"FortifyAviatorError":{"type":"object","properties":{"exitCode":{"type":"string"},"error":{"type":"string"}}},"SiteTreeListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/SiteTree"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"SiteTree":{"description":"Site Tree","type":"object","properties":{"requestTime":{"description":"The request time","type":"string"},"scheme":{"description":"The scheme","type":"string"},"host":{"description":"The host name","type":"string"},"port":{"description":"The port","type":"string"},"method":{"description":"The method","type":"string"},"path":{"description":"The site path","type":"string"},"statusCode":{"description":"The status code returned on the response","type":"string"},"responseTimeDelta":{"description":"The delta for the response time","type":"string"},"spaDisplayName":{"description":"The display name for the SPA","type":"string"},"spaDisplaySelector":{"description":"The selector for the SPA (e.g. a[@id=\"Submit\"])","type":"string"}}},"MobileValidationStatus":{"type":"object","properties":{"validationStatus":{"description":"The validationStatus property (ScanId not found, Processing, OK, etc.)","type":"string"},"Items":{"type":"array","items":{"$ref":"#/definitions/MobileValidationCheckItem"}}}},"MobileValidationCheckItem":{"type":"object","properties":{"result":{"description":"The result property (Ok, Fail, etc.)","type":"string"},"message":{"description":"The message as reported from mobius property","type":"string"}}},"PutScanRequest":{"description":"Put Scan Request","type":"object","properties":{"attributes":{"description":"Scan attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ApplicationAttribute"}}}},"PutScanResponse":{"description":"Put Scan Response","type":"object","properties":{"success":{"description":"Indicates if the scan was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"StaticScanSetup":{"description":"StaticScanSetup","type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The AssessmentTypeId. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementId":{"format":"int32","description":"The assigned entitlementId","type":"integer"},"entitlementFrequencyType":{"description":"The EntitlementFrequencyType.","enum":["SingleScan","Subscription"],"type":"string"},"releaseId":{"format":"int32","description":"The ReleaseId","type":"integer"},"technologyStackId":{"format":"int32","description":"The TechnologyStackId. Values can be obtained by calling GET /api/v3/lookup-items?type=TechnologyTypes","type":"integer"},"technologyStack":{"description":"The TechnologyStack. Values can be obtained by calling GET /api/v3/lookup-items?type=TechnologyTypes","type":"string"},"languageLevelId":{"format":"int32","description":"The LanguageLevelId. Values can be obtained by calling GET /api/v3/lookup-items?type=LanguageLevels","type":"integer"},"languageLevel":{"description":"The LanguageLevel. Values can be obtained by calling GET /api/v3/lookup-items?type=LanguageLevels","type":"string"},"performOpenSourceAnalysis":{"description":"Indicates if open source analysis should be performed","type":"boolean"},"auditPreferenceType":{"description":"The AuditPreferenceType.","enum":["Manual","Automated"],"type":"string"},"includeThirdPartyLibraries":{"description":"Indicates if third party libraries should be included","type":"boolean"},"useSourceControl":{"description":"Indicates if source control should be used","type":"boolean"},"scanBinary":{"description":"Indicates if binary files should be scanned. AKA \"Mixed Mode\" scanning","type":"boolean"},"bsiToken":{"description":"The build server integration token","type":"string"},"includeFortifyAviator":{"description":"Indicates whether FortifyAviator Addon Service is enabled","type":"boolean"},"scanPolicy":{"description":"The Scan Policy.","type":"string"}}},"PutStaticScanSetupRequest":{"description":"PutStaticScanSetupRequest","type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The AssessmentTypeId. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"entitlementFrequencyType":{"description":"The EntitlementFrequencyType","enum":["SingleScan","Subscription"],"type":"string"},"EntitlementId":{"format":"int32","description":"The EntitlementId.","type":"integer"},"technologyStackId":{"format":"int32","description":"The TechnologyStackId. Values can be obtained by calling GET /api/v3/lookup-items?type=TechnologyTypes","type":"integer"},"languageLevelId":{"format":"int32","description":"The LanguageLevelId. Values can be obtained by calling GET /api/v3/lookup-items?type=LanguageLevels","type":"integer"},"performOpenSourceAnalysis":{"description":"Indicates if open source analysis should be performed","type":"boolean"},"auditPreferenceType":{"description":"The AuditPreferenceType","enum":["Manual","Automated"],"type":"string"},"includeThirdPartyLibraries":{"description":"Indicates if third party libraries should be included","type":"boolean"},"useSourceControl":{"description":"Indicates if source control should be used","type":"boolean"},"scanBinary":{"description":"Indicates if source control should be used","type":"boolean"},"includeFortifyAviator":{"type":"boolean"},"scanPolicy":{"description":"The Scan Policy. Values can be obtained by calling GET /api/v3/scan-policies","enum":["Security","DevOps","Classic","FoD_Legacy"],"type":"string"}}},"PutStaticScanSetupResponse":{"description":"Put Static Scan Setup Response","type":"object","properties":{"success":{"description":"Indicates if the static scan settings were updated","type":"boolean"},"bsiToken":{"description":"The build server integration token","type":"string"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}},"messages":{"description":"List of informational messages","type":"array","items":{"type":"string"}},"legalMessage":{"description":"Legal messages","type":"string"}}},"ImportSarifScanResponse":{"type":"object","properties":{"referenceId":{"description":"Reference Id","type":"string"}}},"GetTenantEntitlementResponse":{"description":"Tenant entitlements response","type":"object","properties":{"subscriptionTypeId":{"format":"int32","description":"The subscription type id","type":"integer"},"subscriptionType":{"description":"The subscription type","type":"string"},"tenantEntitlements":{"description":"The list of tenant entitlements","type":"array","items":{"$ref":"#/definitions/TenantEntitlement"}}}},"TenantEntitlement":{"description":"Tenant entitlement","type":"object","properties":{"entitlementId":{"format":"int32","description":"The entitlement id","type":"integer"},"entitlementType":{"description":"The entitlement type","type":"string"},"analysisType":{"description":"The Analysis type","type":"string"},"entitlementDescription":{"description":"The entitlement description","type":"string"},"unitsPurchased":{"format":"int32","description":"The units purchased","type":"integer"},"unitsConsumed":{"format":"int32","description":"The units consumed","type":"integer"},"developerCount":{"format":"int32","description":"The developers purchased","type":"integer"},"startDate":{"format":"date-time","description":"The start date of the entitlement","type":"string"},"endDate":{"format":"date-time","description":"The end date of the entitlement","type":"string"},"extendedProperties":{"$ref":"#/definitions/TenantEntitlementExtendedProperties","description":"Extended properties for the entitlement"}}},"TenantEntitlementExtendedProperties":{"description":"Extended properties","type":"object","properties":{"assessmentTypeId":{"format":"int32","description":"The assessment type id. Values can be obtained by calling GET /api/v3/releases/{releaseId}/assessment-types","type":"integer"},"frequencyTypeId":{"format":"int32","description":"The frequency type id","type":"integer"},"frequencyType":{"description":"The frequency type","type":"string"},"subscriptionLength":{"description":"The subscription lenght","type":"string"}}},"GetTenantOpenSourceEntitlementsResponse":{"description":"Tenant OpenSource entitlements response","type":"object","properties":{"entitlementTypeId":{"format":"int32","description":"The entitlement type id","type":"integer"},"tenant-Oss-Entitlements":{"type":"array","items":{"$ref":"#/definitions/TenantEntitlement"}}}},"TenantHeatMap":{"description":"Tenant Heat Map","type":"object","properties":{"starRating":{"format":"int32","description":"Star rating of application","type":"integer"},"businessCriticalityId":{"format":"int32","description":"Business Criticality Id of application","type":"integer"},"businessCriticality":{"description":"Business Criticality of application","type":"string"},"projectCountText":{"description":"The project count text","type":"string"},"url":{"description":"Url to the heat map","type":"string"}}},"TenantFeatureListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/TenantFeature"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"TenantFeature":{"description":"Tenant Feature","type":"object","properties":{"id":{"format":"int32","description":"The tenant feature id","type":"integer"},"name":{"description":"The tenant feature name","type":"string"}}},"GetTenantResponse":{"description":"Get Tenant Response","type":"object","properties":{"tenantName":{"description":"The tenant name","type":"string"},"tenantCode":{"description":"The tenant code","type":"string"},"timeZone":{"description":"The tenant timezone. Values can be obtained by calling GET /api/v3/lookup-items?type=TimeZones","type":"string"}}},"TenantSummaryListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/TenantSummary"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"TenantSummary":{"description":"Tenant Summary","type":"object","properties":{"totalReleaseCount":{"format":"int32","description":"The number of releases","type":"integer"},"scannedApplicationCount":{"format":"int32","description":"The number of scanned applications","type":"integer"},"totalAnalysisCount":{"format":"int32","description":"The number of all analyses","type":"integer"},"staticAnalysisCount":{"format":"int32","description":"The number of static analyses","type":"integer"},"dynamicAnalysisCount":{"format":"int32","description":"The number of dynamic analyses","type":"integer"},"mobileAnalysisCount":{"format":"int32","description":"The number of mobile analyses","type":"integer"},"staticAnalysisDVIdx":{"format":"int64","description":"The static analysis dvidx","type":"integer"},"dynamicAnalysisDVIdx":{"format":"int64","description":"The dynamic analysis dvidx","type":"integer"},"mobileAnalysisDVIdx":{"format":"int64","description":"The mobile analysis dvidx","type":"integer"},"criticalCount":{"format":"int32","description":"The number of critical issues","type":"integer"},"highCount":{"format":"int32","description":"The number of high issues","type":"integer"},"mediumCount":{"format":"int32","description":"The number of medium issues","type":"integer"},"lowCount":{"format":"int32","description":"The number of low issues","type":"integer"},"criticalUrl":{"description":"The critical url","type":"string"},"highUrl":{"description":"The high url","type":"string"},"mediumUrl":{"description":"The medium url","type":"string"},"lowUrl":{"description":"The low url","type":"string"},"unassessedCount":{"format":"int32","description":"The number of unaccessed applications","type":"integer"},"oneStarRatingCount":{"format":"int32","description":"The number of one star applications","type":"integer"},"twoStarRatingCount":{"format":"int32","description":"The number of two star applications","type":"integer"},"threeStarRatingCount":{"format":"int32","description":"The number of three star applications","type":"integer"},"fourStarRatingCount":{"format":"int32","description":"The number of four star applications","type":"integer"},"fiveStarRatingCount":{"format":"int32","description":"The number of five star applications","type":"integer"},"oneStarRatingDVIdx":{"format":"int64","description":"The one star rating dvidx","type":"integer"},"twoStarRatingDVIdx":{"format":"int64","description":"The two star rating dvidx","type":"integer"},"threeStarRatingDVIdx":{"format":"int64","description":"The three star rating dvidx","type":"integer"},"fourStarRatingDVIdx":{"format":"int64","description":"The four star rating dvidx","type":"integer"},"fiveStarRatingDVIdx":{"format":"int64","description":"The five star rating dvidx","type":"integer"}}},"UserApplicationAccessListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/UserApplicationAccess"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"UserApplicationAccess":{"description":"User Application Access","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The application name","type":"string"},"userId":{"format":"int32","description":"The user id","type":"integer"},"accessMethod":{"description":"The access method","type":"string"}}},"PostUserApplicationAccessRequest":{"description":"Post User Application Access Request","required":["applicationId"],"type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"}}},"UserGroupApplicationAccessListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/UserGroupApplicationAccess"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"UserGroupApplicationAccess":{"description":"User Group Application Access","type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"},"applicationName":{"description":"The application name","type":"string"},"userGroupId":{"format":"int32","description":"The user group id","type":"integer"},"userGroupName":{"description":"The user group name","type":"string"}}},"PostUserGroupApplicationAccessRequest":{"description":"Post User Group Application Access Request","required":["applicationId"],"type":"object","properties":{"applicationId":{"format":"int32","description":"The application id","type":"integer"}}},"UserGroupListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/UserGroup"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"UserGroup":{"description":"User Group","type":"object","properties":{"id":{"format":"int32","description":"The user group id","type":"integer"},"name":{"description":"The user group name","type":"string"},"description":{"description":"The user group description","type":"string"},"assignedUsersCount":{"format":"int32","description":"The assigned users count","type":"integer"},"assignedApplicationsCount":{"format":"int32","description":"The assigned applications count","type":"integer"},"createdVia":{"description":"How the user was created","type":"string"}}},"PostUserGroupRequest":{"description":"Post user group Request","required":["name"],"type":"object","properties":{"name":{"description":"The group name","type":"string"},"description":{"description":"The group description","type":"string"},"addAllUsers":{"description":"Optional - if true add all tenant users to the group. Default is false","type":"boolean"},"users":{"description":"Optional - list of users to add to the group. If addAllUsers is true this list is ignored","type":"array","items":{"format":"int32","type":"integer"}}}},"PostUserGroupResponse":{"description":"Post User Group Response","type":"object","properties":{"id":{"format":"int32","description":"The id of the group","type":"integer"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PutUserGroupRequest":{"description":"Put Group Request","type":"object","properties":{"name":{"description":"The group name","type":"string"},"removeAllUsers":{"description":"Optional - if true remove all users from the group. Default is false","type":"boolean"},"addAllUsers":{"description":"Optional - if true add all tenant users to the group. Default is false","type":"boolean"}}},"GenericResponse":{"description":"Generic Response","type":"object","properties":{"success":{"description":"Indicates if the object was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PatchUserGroupMembershipRequest":{"description":"Post group Request","type":"object","properties":{"removeUsers":{"description":"Optional - list of users' Id to remove from the group","type":"array","items":{"format":"int32","type":"integer"}},"addUsers":{"description":"Optional - list of users' Id to add to the group","type":"array","items":{"format":"int32","type":"integer"}}}},"UserListResponse":{"description":"Generic List Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/User"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"User":{"description":"User","type":"object","properties":{"userId":{"format":"int32","description":"The users's id","type":"integer"},"userName":{"description":"The users's username","type":"string"},"firstName":{"description":"The users's first name","type":"string"},"lastName":{"description":"The users's last name","type":"string"},"email":{"description":"The users's email address","type":"string"},"phoneNumber":{"description":"The users's phone number","type":"string"},"isVerified":{"description":"Indicates if the user has been verified","type":"boolean"},"roleId":{"format":"int32","description":"The users's role id","type":"integer"},"roleName":{"description":"The users's role name","type":"string"},"isSuspended":{"description":"Indicates if the user's account is suspended","type":"boolean"},"mustChange":{"description":"Indicates if the user must change the password on the next login","type":"boolean"},"passwordNeverExpires":{"description":"Indicates if the password never expires","type":"boolean"},"modifiedDate":{"format":"date-time","description":"The users's modified date","type":"string"},"lastLoginDate":{"format":"date-time","description":"The users's last login date","type":"string"},"createdVia":{"description":"How the user was created","type":"string"}}},"PutUserRequest":{"description":"Put User Request","required":["email","firstName","lastName","roleId"],"type":"object","properties":{"email":{"description":"The user's email address","type":"string"},"firstName":{"description":"The user's first name","type":"string"},"lastName":{"description":"The user's last name","type":"string"},"phoneNumber":{"description":"The user's phone number","type":"string"},"roleId":{"format":"int32","description":"The user's role id","type":"integer"},"passwordNeverExpires":{"description":"Indicates if the password never expires","type":"boolean"},"isSuspended":{"description":"Indicates if the user's account is suspended","type":"boolean"},"mustChange":{"description":"Indicates if the user must change the password on the next login","type":"boolean"},"password":{"description":"The user's password","type":"string"}}},"PutUserResponse":{"description":"Put Release Response","type":"object","properties":{"success":{"description":"Indicates if the user was updated","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"DeleteUserResponse":{"description":"Delete User Response","type":"object","properties":{"success":{"description":"Indicates if the user was deleted","type":"boolean"},"errors":{"description":"A list of errors encountered","type":"array","items":{"type":"string"}}}},"PostUserRequest":{"description":"Post User Request","required":["userName","email","firstName","lastName","roleId"],"type":"object","properties":{"userName":{"description":"The username","type":"string"},"email":{"description":"The user's email address","type":"string"},"firstName":{"description":"The user's first name","type":"string"},"lastName":{"description":"The user's last name","type":"string"},"phoneNumber":{"description":"The user's phone number","type":"string"},"roleId":{"format":"int32","description":"The The user's role id","type":"integer"},"passwordNeverExpires":{"description":"Indicates if the password never expires","type":"boolean"},"isSuspended":{"description":"Indicates if the user's account is suspended","type":"boolean"}}},"PostUserResponse":{"description":"Post User Response","type":"object","properties":{"userId":{"format":"int32","description":"The id of the user","type":"integer"}}},"GetVulnerabilitiesResponseVulnerabilityListItem":{"description":"Get Vulnerabilities Response","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/VulnerabilityListItem"}},"filters":{"description":"The list of filters","type":"array","items":{"$ref":"#/definitions/FieldFilter"}},"totalCount":{"format":"int32","description":"The total count of items","type":"integer"},"isRepositoryUpdating":{"description":"Indicates if the repository is being updated","type":"boolean"},"offset":{"format":"int32","description":"Offset of the starting record. 0 indicates the first record.","type":"integer"},"limit":{"format":"int32","description":"Maximum records to return.","type":"integer"}}},"VulnerabilityListItem":{"description":"Vulnerability List Item","type":"object","properties":{"id":{"format":"int32","description":"Id","type":"integer"},"releaseId":{"format":"int32","description":"Release id","type":"integer"},"fisma":{"description":"FISMA","type":"string"},"nistsp800_53rev5":{"description":"NIST SP 800-53 Rev.5","type":"string"},"severityString":{"description":"Severity string","type":"string"},"severity":{"format":"int32","description":"Severity numeric value","type":"integer"},"category":{"description":"Category","type":"string"},"kingdom":{"description":"Kingdom","type":"string"},"owasp2017":{"description":"OWASP 2017","type":"string"},"owasp2021":{"description":"OWASP 2021","type":"string"},"owasp2023":{"description":"OWASP 2023","type":"string"},"owaspAsvs4_0":{"description":"OWASP ASVS 4.0","type":"string"},"OWASP_ASVS_4_0":{"type":"string"},"owaspAsvs5_0":{"description":"OWASP ASVS 5.0","type":"string"},"owaspTop10_2025":{"description":"OWASP Top 10 2025","type":"string"},"owaspTop10_LLMApplications_2025":{"description":"OWASP Top 10 2025","type":"string"},"cwe":{"description":"CWE","type":"string"},"cwetop25_2023":{"description":"CWE Top 25 2023","type":"string"},"cwetop25_2024":{"description":"CWE Top 25 2024","type":"string"},"cwetop25_2025":{"description":"CWE Top 25 2025","type":"string"},"package":{"description":"Package","type":"string"},"primaryLocation":{"description":"Primary location","type":"string"},"vulnId":{"description":"Vulnerability id","type":"string"},"analysisType":{"description":"Analysis type","type":"string"},"lineNumber":{"format":"int32","description":"Line number","type":"integer"},"hasComments":{"description":"Has Comments","type":"boolean"},"assignedUser":{"description":"Assigned user","type":"string"},"scantype":{"description":"Scan type. Values can be obtained by calling GET /api/v3/lookup-items?type=ScanTypes","type":"string"},"subtype":{"description":"Sub type","type":"string"},"primaryLocationFull":{"description":"Primary location full","type":"string"},"hasAttachments":{"description":"Has attachments","type":"boolean"},"pci1_2":{"description":"PCI 1.2","type":"string"},"pci2":{"description":"PCI 2.0","type":"string"},"wasc24_2":{"description":"WASC242","type":"string"},"isSuppressed":{"description":"Is suppressed","type":"boolean"},"suppressedBy":{"description":"Is suppressed","type":"string"},"scanId":{"format":"int32","description":"Scan id","type":"integer"},"pci3":{"description":"PCI 3.0","type":"string"},"pci4":{"description":"PCI 4.0","type":"string"},"pci401":{"description":"PCI 4.0.1","type":"string"},"pcissf1":{"description":"PCI SSF 1.0","type":"string"},"stig6":{"description":"STIG 6.x","type":"string"},"instanceId":{"description":"Instance id","type":"string"},"auditPendingAuditorStatus":{"description":"Audit Pending - Auditor Status","type":"string"},"auditorStatus":{"description":"Auditor Status","type":"string"},"checkId":{"description":"Check Id","type":"string"},"closedDate":{"format":"date-time","description":"Closed Date","type":"string"},"closedStatus":{"description":"Closed Status","type":"boolean"},"developerStatus":{"description":"Developer Status","type":"string"},"falsePositiveChallenge":{"description":"False Positive Challenge","type":"string"},"introducedDate":{"description":"Introduced Date","type":"string"},"scanStartedDate":{"format":"date-time","description":"Scan Started Date","type":"string"},"scanCompletedDate":{"format":"date-time","description":"Scan Completed Date","type":"string"},"status":{"description":"Status","type":"string"},"bugSubmitted":{"description":"Bug Submitted","type":"boolean"},"bugLink":{"description":"Bug Link","type":"string"},"auditPendingSuppression":{"description":"Audit Pending Suppression","type":"string"},"source":{"description":"Source","type":"string"},"sink":{"description":"Sink","type":"string"},"timeToFixDays":{"format":"int32","description":"Sink","type":"integer"},"fortifyAviator":{"description":"Fortify Aviator","type":"boolean"},"lastModifiedDate":{"format":"date-time","type":"string"},"aviatorRemediationGuidanceAvailable":{"type":"boolean"},"exploited":{"description":"Exploited (CISA)","type":"boolean"},"malware":{"description":"Malware","type":"boolean"}}},"VulnerabilityAllData":{"description":"All data for the vulnerability","type":"object","properties":{"summary":{"$ref":"#/definitions/VulnerabilitySummary","description":"The vulnerability summary"},"details":{"$ref":"#/definitions/VulnerabilityDetails","description":"The vulnerability details"},"recommendations":{"$ref":"#/definitions/VulnerabilityRecommendations","description":"The vulnerability recommendations"},"screenshots":{"description":"List of vulnerability screenshots","type":"array","items":{"$ref":"#/definitions/VulnerabilityScreenshotItem"}},"history":{"description":"List of vulnerability history","type":"array","items":{"$ref":"#/definitions/VulnerabilityHistoryItem"}},"requestResponse":{"$ref":"#/definitions/VulnerabilityRequestResponse","description":"The vulnerability request and response"},"headers":{"$ref":"#/definitions/VulnerabilityHeaders","description":"The vulnerability headers"},"parameters":{"$ref":"#/definitions/VulnerabilityParameters","description":"The vulnerability parameters"},"traces":{"description":"The vulnerability traces","type":"array","items":{"$ref":"#/definitions/VulnerabilityTraceItem"}},"auditOptions":{"$ref":"#/definitions/VulnerabilityAuditOptions","description":"The vulnerability audit options"},"attributes":{"description":"The vulnerability attribute","type":"array","items":{"$ref":"#/definitions/AttributeItemModel"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilitySummary":{"description":"Vulnerability Summary","type":"object","properties":{"lineNumber":{"format":"int32","description":"Line number","type":"integer"},"primaryLocation":{"description":"Primary location","type":"string"},"primaryLocationFull":{"description":"The full Primary location","type":"string"},"severity":{"description":"Severity","type":"string"},"isSuppressed":{"description":"Is suppressed","type":"boolean"},"assignedUser":{"description":"Assigned user","type":"string"},"developerStatus":{"description":"Developer status","type":"string"},"auditorStatus":{"description":"Auditor status","type":"string"},"auditPending":{"description":"Audit pending","type":"boolean"},"auditPendingAuditorStatus":{"description":"Audit pending auditor status","type":"string"},"auditPendingSeverity":{"description":"Audit pending severity","type":"string"},"auditPendingSuppression":{"description":"Audit pending suppression","type":"string"},"comments":{"description":"Comments","type":"array","items":{"$ref":"#/definitions/AuditComment"}},"notes":{"description":"Notes","type":"string"},"bugSubmitted":{"description":"Bug Submitted","type":"boolean"},"bugLink":{"description":"Bug Link","type":"string"},"fileLocations":{"description":"File locations for open source vulnerabilities","type":"array","items":{"type":"string"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityDetails":{"description":"Vulnerability Details","type":"object","properties":{"isStatic":{"description":"Indicates if the vulnerability is static","type":"boolean"},"summary":{"description":"The vulnerability summary","type":"string"},"explanation":{"description":"The vulnerability explanation","type":"string"},"instanceId":{"description":"The vulnerability instance id","type":"string"},"ruleId":{"description":"The vulnerability rule id","type":"string"},"impact":{"description":"The vulnerability impact","type":"string"},"probability":{"description":"The vulnerability probability","type":"string"},"severity":{"description":"The vulnerability severity","type":"string"},"confidence":{"description":"The vulnerability confidence","type":"string"},"analyzerName":{"description":"The vulnerability analyzer name","type":"string"},"source":{"description":"The vulnerability source name","type":"string"},"sink":{"description":"The vulnerability sink name","type":"string"},"complianceCategories":{"description":"The compliance rules which pertain to this vulnerability, grouped by category.","type":"array","items":{"$ref":"#/definitions/VulnerabilityComplianceCategory"}},"remainingRemediationGracePeriodDays":{"format":"int32","description":"The number of days remaining in the remediation grace period\r\nThis will be negative if the grace period has expired","type":"integer"},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityRecommendations":{"description":"Vulnerability Recommendations","type":"object","properties":{"isStatic":{"description":"Is static","type":"boolean"},"recommendations":{"description":"Recommendations","type":"string"},"tips":{"description":"Tips","type":"string"},"references":{"description":"References","type":"string"},"sonatype":{"$ref":"#/definitions/SonatypeRecommendations"},"secureCodeWarrior":{"$ref":"#/definitions/SecureCodeWarriorModel"},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityScreenshotItem":{"description":"Vulnerability Screenshot Item","type":"object","properties":{"id":{"format":"int32","description":"Id","type":"integer"},"name":{"description":"Name","type":"string"},"description":{"description":"Description","type":"string"},"uploadDate":{"format":"date-time","description":"Upload date","type":"string"}}},"VulnerabilityHistoryItem":{"description":"Vulnerability History Item","type":"object","properties":{"content":{"description":"The history content","type":"string"},"historyDateTime":{"format":"date-time","description":"The history date time","type":"string"},"user":{"description":"The user that created the history item","type":"string"},"historyType":{"description":"The history type of the item","type":"string"}}},"VulnerabilityRequestResponse":{"description":"Vulnerability Request Response","type":"object","properties":{"requestContent":{"description":"Request content","type":"string"},"responseContent":{"description":"Response content","type":"string"},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityHeaders":{"description":"Vulnerability Headers","type":"object","properties":{"requestHeaders":{"description":"The request headers","type":"array","items":{"$ref":"#/definitions/VulnerabilityHeader"}},"responseHeaders":{"description":"The response headers","type":"array","items":{"$ref":"#/definitions/VulnerabilityHeader"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityParameters":{"description":"Vulnerability Parameters","type":"object","properties":{"queryParameters":{"description":"Query parameters","type":"array","items":{"$ref":"#/definitions/VulnerabilityParameter"}},"postParameters":{"description":"Post parameters","type":"array","items":{"$ref":"#/definitions/VulnerabilityParameter"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityTraceItem":{"description":"Vulnerability Trace Item","type":"object","properties":{"traceIndex":{"format":"int32","description":"Trace index","type":"integer"},"traceEntries":{"description":"List of trace entries","type":"array","items":{"$ref":"#/definitions/VulnerabilityTraceEntry"}}}},"VulnerabilityAuditOptions":{"description":"Vulnerability Audit Options","type":"object","properties":{"canAudit":{"description":"Indicates if the current user can audit the vulnerability","type":"boolean"},"canChallenge":{"description":"Indicates if the current user can challenge the vulnerability","type":"boolean"},"canEdit":{"description":"Indicates if the current user can edit the vulnerability","type":"boolean"},"inAuditMode":{"description":"Indicates if the release is in audit mode","type":"boolean"},"auditProcessing":{"description":"Indicates if the audit is processing for the release","type":"boolean"},"auditActions":{"description":"List of available audit actions","type":"array","items":{"$ref":"#/definitions/AuditAction"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"AttributeItemModel":{"type":"object","properties":{"attributeName":{"description":"The attribute name","type":"string"},"attributeValue":{"description":"The attribute value","type":"string"}}},"AuditComment":{"description":"Audit Comment","type":"object","properties":{"username":{"description":"The user name","type":"string"},"commentDate":{"format":"date-time","description":"The comment date","type":"string"},"comment":{"description":"The audit comment","type":"string"}}},"VulnerabilityComplianceCategory":{"description":"Vulnerability compliance category.","type":"object","properties":{"categoryName":{"description":"The compliance category name.","type":"string"},"complianceItems":{"description":"The compliance items for the current category.","type":"array","items":{"$ref":"#/definitions/VulnerabilityComplianceItem"}}}},"SonatypeRecommendations":{"description":"Sonatype Recommendations","type":"object","properties":{"explanation":{"description":"Explanation","type":"string"},"detection":{"description":"Detection","type":"string"},"recommendation":{"description":"Recommendations","type":"string"},"nextNonVulnerableVersion":{"description":"Next non vulnerable version","type":"string"},"greatestNonVulnerableVersion":{"description":"Greatest non vulnerable version","type":"string"},"links":{"description":"An array of links","type":"array","items":{"type":"string"}}}},"SecureCodeWarriorModel":{"type":"object","properties":{"url":{"type":"string"},"videoUrls":{"type":"array","items":{"type":"string"}},"cweTrainings":{"type":"array","items":{"$ref":"#/definitions/TrainingLinks"}}}},"VulnerabilityHeader":{"description":"Vulnerability Header","type":"object","properties":{"name":{"description":"The header name","type":"string"},"value":{"description":"The header value","type":"string"},"cookieHeaders":{"description":"The list of cookie headers","type":"array","items":{"$ref":"#/definitions/VulnerabilityHeader"}}}},"VulnerabilityParameter":{"description":"Vulnerability Parameter","type":"object","properties":{"name":{"description":"Name","type":"string"},"value":{"description":"Value","type":"string"},"decodedValue":{"description":"Decoded value","type":"string"}}},"VulnerabilityTraceEntry":{"description":"Vulnerability Trace Entry","type":"object","properties":{"index":{"format":"int32","description":"Index","type":"integer"},"lineNumber":{"format":"int32","description":"Line number","type":"integer"},"displayText":{"description":"Display text","type":"string"},"location":{"description":"Location","type":"string"},"actionType":{"description":"Action type","type":"string"}}},"AuditAction":{"description":"Audit Action","type":"object","properties":{"auditActionType":{"description":"The audit action type","enum":["AuditorStatus","DeveloperStatus","Severity","User"],"type":"string"},"auditActionTypeName":{"description":"The audit action type name","type":"string"},"items":{"description":"List of audit action items","type":"array","items":{"$ref":"#/definitions/LookupItem"}}}},"VulnerabilityComplianceItem":{"description":"Vulnerability compliance item.","type":"object","properties":{"complianceRule":{"description":"The compliance rule.","type":"string"}}},"TrainingLinks":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}},"VulnerabilityHistory":{"description":"Vulnerability History","type":"object","properties":{"items":{"description":"The list of history items","type":"array","items":{"$ref":"#/definitions/VulnerabilityHistoryItem"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityScreenshot":{"description":"Vulnerability Screenshot","type":"object","properties":{"items":{"description":"List of screenshots","type":"array","items":{"$ref":"#/definitions/VulnerabilityScreenshotItem"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityTrace":{"description":"Vulnerability Trace","type":"object","properties":{"items":{"description":"List of trace items","type":"array","items":{"$ref":"#/definitions/VulnerabilityTraceItem"}},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityTraceCode":{"description":"Vulnerability Trace Code","type":"object","properties":{"sourceFileContent":{"description":"Source file content","type":"string"},"sourceFileExtension":{"description":"Source file extension","type":"string"},"sourceStartLineNumber":{"format":"int32","description":"Source start line number","type":"integer"},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"VulnerabilityTraceCodeSnippet":{"type":"object","properties":{"endLine":{"format":"int32","description":"Source file extension","type":"integer"},"file":{"description":"File","type":"string"},"startLine":{"format":"int32","description":"Source file content","type":"integer"},"text":{"description":"Source start line number","type":"string"},"vulnId":{"description":"The vulnerability id","type":"string"},"Id":{"format":"int32","description":"The issue id","type":"integer"},"releaseId":{"format":"int32","description":"The release id","type":"integer"}}},"PostVulnerabilityBulkEditRequest":{"description":"Post Vulnerability Bulk Edit Request","type":"object","properties":{"userId":{"description":"The id of the user","type":"string"},"developerStatus":{"description":"The developer status","type":"string"},"auditorStatus":{"description":"The auditor status","type":"string"},"severity":{"description":"The severity","type":"string"},"comment":{"description":"The comment","type":"string"},"vulnerabilityIds":{"description":"The list of vulnerability ids to edit","type":"array","items":{"type":"string"}},"includeAllVulnerabilities":{"description":"Include all vulnerabilities for the release","type":"boolean"},"attributes":{"description":"Application attributes. This is an array of key/value objects. Example, [{\"Attribute 1\": \"value 1\"}, {\"Attribute 2\": \"value 2\"}, {\"Attribute 3\": \"value 3\"} ]","type":"array","items":{"$ref":"#/definitions/ItemAttribute"}}}},"ItemAttribute":{"type":"object","properties":{"id":{"format":"int32","description":"Id of the attribute","type":"integer"},"Value":{"description":"Value of the attribute","type":"string"}}},"PostVulnerabilityBulkEditResponse":{"description":"Post Vulnerability Bulk Edit Response","type":"object","properties":{"results":{"description":"List of results","type":"array","items":{"$ref":"#/definitions/VulnerabilityBulkUpdateResult"}},"attributeerrors":{"description":"Attribute validation message","type":"array","items":{"type":"string"}}}},"VulnerabilityBulkUpdateResult":{"description":"Vulnerability Bulk Update Result","type":"object","properties":{"vulnerabilityId":{"description":"The vulnerability id","type":"string"},"errorCode":{"format":"int32","description":"The error code","type":"integer"}}},"FieldFilterListResponse":{"description":"FieldFilterListResponse","type":"object","properties":{"items":{"description":"The list of items","type":"array","items":{"$ref":"#/definitions/FieldFilter"}},"totalCount":{"format":"int32","description":"Total count of items","type":"integer"},"isRepositoryUpdating":{"description":"Indicates if the repository is being updated","type":"boolean"}}},"PostVulnerabilityBugLinkRequest":{"description":"Post Vulnerability Bug Link Request","required":["bugLink","vulnerabilityIds"],"type":"object","properties":{"bugLink":{"description":"The bug link","type":"string"},"vulnerabilityIds":{"description":"The list of vulnerability ids to edit","type":"array","items":{"type":"string"}}}},"VulnerabilityAuditCommentsResponse":{"description":"Get the Audit Comments for given Vulnerability Id","type":"object","properties":{"items":{"description":"List of comments","type":"array","items":{"$ref":"#/definitions/AuditComment"}},"releaseId":{"format":"int32","description":"The ID of the release that the vulnerability belongs to.","type":"integer"},"vulnId":{"description":"The Vulnerability ID associated with the release.","type":"string"},"id":{"format":"int32","description":"The issue ID.","type":"integer"}}}}}