| title | Integrators Tool Reference | |
|---|---|---|
| description | Detailed setup guides for Integrators | |
| weight | 1 | |
| audience | pro | |
| aliases |
|
Here are specific instructions detailing how to set up a DefectDojo Integration with a third party Issue Tracker.
- Label should be the label that you want to use to identify this integration.
- Location should be set to your Azure URL - for example
https://dev.azure.com/{your organization} - Token should be set to a personal access token from Azure.
Authentication with Azure DevOps requires a personal access token with permissions set to "Read, Write and Manage" for "Work Items" for the Azure Project that you wish to work with.
These details dictate how DefectDojo will map Finding or Finding Group attributes to a given Project in Azure DevOps:
The Project ID field corresponds to the name or the ID of the Project in Azure.
The attributes in the form are supplied as defaults, and are as follows:
- Severity Field Name:
/fields/Microsoft.VSTS.Common.Priority - Info Mapping:
4 - Low Mapping:
4 - Medium Mapping:
3 - High Mapping:
2 - Critical Mapping:
1
The attributes in the form are supplied as defaults and are as follows:
- Status Field Name:
/fields/System.State - Active Mapping:
To Do - Closed Mapping:
Done - False Positive Mapping:
Done - Risk Accepted Mapping:
Done
The GitHub integration allows you to add issues to a GitHub Project, which also open Issues in an associated Repo. These Repos/Projects can be associated with either a GitHub Organization or a personal GitHub account.
- Label should be the label that you want to use to identify this integration.
- Location should be set to your GitHub User or Organization URL, depending on where you wish to create issues. for example
https://github.com/{your-organization} - Token should be set to a personal access token from GitHub.
Personal access tokens for GitHub can be created at https://github.com/settings/tokens. The token must have Repo and Project scopes.
- Issue Tracker Mapping Label should be set to identify the Project or Repo that you wish to create Issues in.
- Project Number should be the ID of a GitHub project that you want to send items to. You can get this from the URL while looking at a Project, for example
https://github.com/orgs/{your-org}/projects/{project number}. - Repository Name should be the name of a repo associated with your organization (or user) that you want to push Issues to.
In order to set up the integration, the Project MUST have a custom field created to represent Issue Priority, otherwise Severity will not be mapped correctly and Issues will not push to GitHub.
Follow this guide to create a custom field. Each Severity will need to have a corresponding single-select option available. For example, out of the box DefectDojo suggests P0, P1, P2, P3, P4 as possible Priority values, and each of those will need to be added to the Priority custom field.
- Severity Field Name:
Priority - Info Mapping:
P0 - Low Mapping:
P1 - Medium Mapping:
P2 - High Mapping:
P3 - Critical Mapping:
P4
By default, new GitHub Projects will have Statuses for Issues of "In Progress" and "Done". Additional statuses can be added to the Project to track False Positive or Risk Accepted status if you wish. One of the ways this can be done is by adding a new Status Column to the Project Board.
- Status Field Name:
Status - Active Mapping:
In Progress - Closed Mapping:
Done - False Positive Mapping:
Done - Risk Accepted Mapping:
Done
The GitLab integration allows you to add issues to a GitLab Project.
- Label should be the label that you want to use to identify this integration.
- Location should be set to the link to your GitLab server, for example
https://gitlab.com/. - Token should be set to a personal access token from GitLab. The token must have API scopes. See GitLab’s guide to creating a personal access token.
- Project Name: The name of the project in GitLab that you want to send issues to.
This maps to the GitLab Priority field.
- Severity Field Name:
Priority - Info Mapping:
1 - Low Mapping:
2 - Medium Mapping:
3 - High Mapping:
4 - Critical Mapping:
5
By default, GitLab has statuses of 'opened' and 'closed'. Additional status labels can be added if you want to track False Positive or Risk Accepted status. See GitLab Docs for details.
- Status Field Name:
Status - Active Mapping:
opened - Closed Mapping:
closed - False Positive Mapping:
closed - Risk Accepted Mapping:
closed
The ServiceNow Integration allows you to push DefectDojo Findings as ServiceNow Incidents.
Your ServiceNow instance will require you to obtain a Refresh Token, associated with the User or Service account that will push Incidents to ServiceNow.
You'll need to start by creating an OAuth registration on your ServiceNow instance for DefectDojo:
- In the left-hand navigation bar, search for “Application Registry” and select it.
- Click “New”.
- Choose “Create an OAuth API endpoint for external clients”.
- Fill in the required fields:
- Name: Provide a meaningful name for your application (e.g., Vulnerability Integration Client).
- (Optional) Adjust the Token Lifespan:
- Access Token Lifespan: Default is 1800 seconds (30 minutes).
- Refresh Token Lifespan: The default is 8640000 seconds (approximately 100 days).
- Click Submit to create the application record.
- After submission, select the application from the list and take note of the Client ID and Client Secret fields.
You will then need to use this registration to obtain a Refresh Token, which can only be obtained through the ServiceNow API. Open a terminal window and paste the following (substituting the variables wrapped in {{}} with your user's actual information)
curl --request POST \
--url {{INSTANCE_HOST}}/oauth_token.do \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=password \
--data 'client_id={{CLIENT_ID}}' \
--data 'client_secret={{CLIENT_SECRET}}' \
--data 'username={{USERNAME}}' \
--data 'password={{PASSWORD}}'
If your ServiceNow credentials are correct, and allow for admin level-access to ServiceNow, you should receive a response with a RefreshToken. You'll need that token to complete integration with DefectDojo.
- Instance Label should be the label that you want to use to identify this integration.
- Location should be set to the URL for your ServiceNow server, for example
https://your-organization.service-now.com/. - Refresh Token is where the Refresh Token should be entered.
- Client ID should be the Client ID set in the OAuth App Registration.
- Client ID should be the Client Secret set in the OAuth App Registration.
This maps to the ServiceNow Impact field.
- Info Mapping:
1 - Low Mapping:
1 - Medium Mapping:
2 - High Mapping:
3 - Critical Mapping:
3
- Status Field Name:
State - Active Mapping:
New - Closed Mapping:
Closed - False Positive Mapping:
Resolved - Risk Accepted Mapping:
Resolved
The Zendesk Integration allows you to push DefectDojo Findings and Finding Groups as Zendesk tickets, assigned to a Zendesk Group of your choice.
- Label should be the label that you want to use to identify this integration.
- Location should be set to your Zendesk account URL, for example
https://your-subdomain.zendesk.com. - Email should be the email address of the Zendesk agent the API token belongs to.
- API Token should be set to a Zendesk API token. An administrator can create one in the Zendesk Admin Center under Apps and integrations > APIs > Zendesk API (token access must be enabled).
- Group ID should be the numeric ID of the Zendesk Group that tickets will be assigned to. You can find it in the Admin Center under People > Team > Groups, or in the URL while viewing the group.
This maps to the Zendesk ticket Priority field, which accepts low, normal, high, and urgent:
- Severity Field Name:
Priority - Info Mapping:
low - Low Mapping:
low - Medium Mapping:
normal - High Mapping:
high - Critical Mapping:
urgent
Zendesk tickets support the statuses new, open, pending, hold, solved, and closed. Note that hold must be enabled on your account before it can be used.
- Status Field Name:
Status - Active Mapping:
new - Closed Mapping:
solved - False Positive Mapping:
solved - Risk Accepted Mapping:
pending
A few Zendesk-specific behaviors to be aware of:
- The ticket description is the first comment in Zendesk and cannot be edited after creation, so pushing an updated Finding will sync the ticket's subject, priority, and status, but not description changes.
- Tickets are marked
solvedrather than deleted when a Finding is removed; Zendesk closes solved tickets automatically after a period of time. closedis a final status - closed tickets cannot be updated at all, and pushing a Finding whose ticket has closed will report an error.