Skip to content

Commit

Permalink
CXFLW-924 Adding document changes for ODATA API request. (#1306)
Browse files Browse the repository at this point in the history
  • Loading branch information
@satyamchaurasiapersistent
satyamchaurasiapersistent authored Jan 22, 2024
1 parent 3f6c5cf commit 9507d96
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ For more details on break build, please refer to [Thresholds and policies](https
| `email-notifications` | | No | | Yes (Scan only) | A map containing any or all of the following keys: `after-scan`, `before-scan`, `failed-scan`. The vaue of each key is a list of email addresses to which a notification should be sent in the case of the relevant event. |
| `project-branching-check-count` | 3 | No | Yes | Yes (Scan only) | The number of times to check the project branching status after a project has been branched. Only relevant for versions of CxSAST that support the querying of the branching status (API version 4 and higher). |
| `project-branching-check-interval` | 5 | No | Yes | Yes (Scan only) | The interval between checks of the project branching status. For versions of CxSAST that do not support querying the project branching status, execution will pause once for the specified duration. |
| `restrict-results-to-branch` | false | No | Yes | Yes (Scan only) | If set to `true`, when scanning a branched project, only results detected on the branch are reported. As the OData API is needed for this functionality, the CxSAST user used must be a assigned a role with the “API” permission. Also, the `client-id` property should be set to “resource_owner_sast_client” and the `scope` property should be set to “sast_api”. |
| `restrict-results-to-branch` | false | No | Yes | Yes (Scan only) | If set to `true`, when scanning a branched project, only results detected on the branch are reported. As the OData API is needed for this functionality, the CxSAST user used must be a assigned a role with the “API” permission. Also, the `client-id` property should be set to “resource_owner_sast_client” and the `scope` property should be set to “access_control_api sast_api”. |
| `forcescan` | false | No | Yes | Yes (--forcescan) | Specifies whether the code should be scanned regardless of unchanged code |
No* = Default is applied

Expand All @@ -592,7 +592,7 @@ No* = Default is applied
| `jira-fields` | No | Yes | Yes | Custom Checkmarx field name to override Jira custom field mappings for a given Checkmarx scan result / project |
| `jira-assignee` | No | Yes | Yes | Custom Checkmarx field name to override Jira assignees for a given Checkmarx scan result / project |


~~~~~~~~~~~~~~~~~~~~~~~~

#### <a name="nine">9.0 Configuration Changes</a>
```yaml
Expand Down

0 comments on commit 9507d96

Please sign in to comment.