Categorygithub.com/prempador/go-defectdojo
repositorypackage
0.0.0-20241001195829-b6c5f3866229
Repository: https://github.com/prempador/go-defectdojo.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for defectdojo

Generation Command

$ curl https://demo.defectdojo.org/api/v2/oa3/schema/\?format\=yaml > ddj-oapi.yaml

$ docker run --rm -u $(id -u):$(id -g) \
    -v $PWD:/local openapitools/openapi-generator-cli generate \
    -i /local/ddj-oapi.yaml \
    -g go \
    -o /local \
    --additional-properties=generateInterfaces=true \
    --additional-properties=packageName=defectdojo \
	--additional-properties=disallowAdditionalPropertiesIfNotPresent=false \
	--additional-properties=useDefaultValuesForRequiredVars=true

$ rm ddj-oapi.yaml

Defect Dojo - Open Source vulnerability Management made easy. Prefetch related parameters/responses not yet in the schema.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2.38.4
  • Package version: 1.0.0
  • Generator version: 7.9.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import defectdojo "github.com/prempador/go-defectdojo"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value defectdojo.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), defectdojo.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value defectdojo.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), defectdojo.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using defectdojo.ContextOperationServerIndices and defectdojo.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), defectdojo.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), defectdojo.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AnnouncementsAPIAnnouncementsCreatePost /api/v2/announcements/
AnnouncementsAPIAnnouncementsDeletePreviewListGet /api/v2/announcements/{id}/delete_preview/
AnnouncementsAPIAnnouncementsDestroyDelete /api/v2/announcements/{id}/
AnnouncementsAPIAnnouncementsListGet /api/v2/announcements/
AnnouncementsAPIAnnouncementsPartialUpdatePatch /api/v2/announcements/{id}/
AnnouncementsAPIAnnouncementsRetrieveGet /api/v2/announcements/{id}/
AnnouncementsAPIAnnouncementsUpdatePut /api/v2/announcements/{id}/
ApiTokenAuthAPIApiTokenAuthCreatePost /api/v2/api-token-auth/
ConfigurationPermissionsAPIConfigurationPermissionsListGet /api/v2/configuration_permissions/
ConfigurationPermissionsAPIConfigurationPermissionsRetrieveGet /api/v2/configuration_permissions/{id}/
CredentialMappingsAPICredentialMappingsCreatePost /api/v2/credential_mappings/
CredentialMappingsAPICredentialMappingsDeletePreviewListGet /api/v2/credential_mappings/{id}/delete_preview/
CredentialMappingsAPICredentialMappingsDestroyDelete /api/v2/credential_mappings/{id}/
CredentialMappingsAPICredentialMappingsListGet /api/v2/credential_mappings/
CredentialMappingsAPICredentialMappingsPartialUpdatePatch /api/v2/credential_mappings/{id}/
CredentialMappingsAPICredentialMappingsRetrieveGet /api/v2/credential_mappings/{id}/
CredentialMappingsAPICredentialMappingsUpdatePut /api/v2/credential_mappings/{id}/
CredentialsAPICredentialsCreatePost /api/v2/credentials/
CredentialsAPICredentialsDeletePreviewListGet /api/v2/credentials/{id}/delete_preview/
CredentialsAPICredentialsDestroyDelete /api/v2/credentials/{id}/
CredentialsAPICredentialsListGet /api/v2/credentials/
CredentialsAPICredentialsPartialUpdatePatch /api/v2/credentials/{id}/
CredentialsAPICredentialsRetrieveGet /api/v2/credentials/{id}/
CredentialsAPICredentialsUpdatePut /api/v2/credentials/{id}/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsCreatePost /api/v2/development_environments/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsDeletePreviewListGet /api/v2/development_environments/{id}/delete_preview/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsDestroyDelete /api/v2/development_environments/{id}/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsListGet /api/v2/development_environments/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsPartialUpdatePatch /api/v2/development_environments/{id}/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsRetrieveGet /api/v2/development_environments/{id}/
DevelopmentEnvironmentsAPIDevelopmentEnvironmentsUpdatePut /api/v2/development_environments/{id}/
DojoGroupMembersAPIDojoGroupMembersCreatePost /api/v2/dojo_group_members/
DojoGroupMembersAPIDojoGroupMembersDeletePreviewListGet /api/v2/dojo_group_members/{id}/delete_preview/
DojoGroupMembersAPIDojoGroupMembersDestroyDelete /api/v2/dojo_group_members/{id}/
DojoGroupMembersAPIDojoGroupMembersListGet /api/v2/dojo_group_members/
DojoGroupMembersAPIDojoGroupMembersRetrieveGet /api/v2/dojo_group_members/{id}/
DojoGroupMembersAPIDojoGroupMembersUpdatePut /api/v2/dojo_group_members/{id}/
DojoGroupsAPIDojoGroupsCreatePost /api/v2/dojo_groups/
DojoGroupsAPIDojoGroupsDeletePreviewListGet /api/v2/dojo_groups/{id}/delete_preview/
DojoGroupsAPIDojoGroupsDestroyDelete /api/v2/dojo_groups/{id}/
DojoGroupsAPIDojoGroupsListGet /api/v2/dojo_groups/
DojoGroupsAPIDojoGroupsPartialUpdatePatch /api/v2/dojo_groups/{id}/
DojoGroupsAPIDojoGroupsRetrieveGet /api/v2/dojo_groups/{id}/
DojoGroupsAPIDojoGroupsUpdatePut /api/v2/dojo_groups/{id}/
EndpointMetaImportAPIEndpointMetaImportCreatePost /api/v2/endpoint_meta_import/
EndpointStatusAPIEndpointStatusCreatePost /api/v2/endpoint_status/
EndpointStatusAPIEndpointStatusDeletePreviewListGet /api/v2/endpoint_status/{id}/delete_preview/
EndpointStatusAPIEndpointStatusDestroyDelete /api/v2/endpoint_status/{id}/
EndpointStatusAPIEndpointStatusListGet /api/v2/endpoint_status/
EndpointStatusAPIEndpointStatusPartialUpdatePatch /api/v2/endpoint_status/{id}/
EndpointStatusAPIEndpointStatusRetrieveGet /api/v2/endpoint_status/{id}/
EndpointStatusAPIEndpointStatusUpdatePut /api/v2/endpoint_status/{id}/
EndpointsAPIEndpointsCreatePost /api/v2/endpoints/
EndpointsAPIEndpointsDeletePreviewListGet /api/v2/endpoints/{id}/delete_preview/
EndpointsAPIEndpointsDestroyDelete /api/v2/endpoints/{id}/
EndpointsAPIEndpointsGenerateReportCreatePost /api/v2/endpoints/{id}/generate_report/
EndpointsAPIEndpointsListGet /api/v2/endpoints/
EndpointsAPIEndpointsPartialUpdatePatch /api/v2/endpoints/{id}/
EndpointsAPIEndpointsRetrieveGet /api/v2/endpoints/{id}/
EndpointsAPIEndpointsUpdatePut /api/v2/endpoints/{id}/
EngagementPresetsAPIEngagementPresetsCreatePost /api/v2/engagement_presets/
EngagementPresetsAPIEngagementPresetsDeletePreviewListGet /api/v2/engagement_presets/{id}/delete_preview/
EngagementPresetsAPIEngagementPresetsDestroyDelete /api/v2/engagement_presets/{id}/
EngagementPresetsAPIEngagementPresetsListGet /api/v2/engagement_presets/
EngagementPresetsAPIEngagementPresetsPartialUpdatePatch /api/v2/engagement_presets/{id}/
EngagementPresetsAPIEngagementPresetsRetrieveGet /api/v2/engagement_presets/{id}/
EngagementPresetsAPIEngagementPresetsUpdatePut /api/v2/engagement_presets/{id}/
EngagementsAPIEngagementsAcceptRisksCreatePost /api/v2/engagements/{id}/accept_risks/
EngagementsAPIEngagementsCloseCreatePost /api/v2/engagements/{id}/close/
EngagementsAPIEngagementsCompleteChecklistCreatePost /api/v2/engagements/{id}/complete_checklist/
EngagementsAPIEngagementsCompleteChecklistRetrieveGet /api/v2/engagements/{id}/complete_checklist/
EngagementsAPIEngagementsCreatePost /api/v2/engagements/
EngagementsAPIEngagementsDeletePreviewListGet /api/v2/engagements/{id}/delete_preview/
EngagementsAPIEngagementsDestroyDelete /api/v2/engagements/{id}/
EngagementsAPIEngagementsFilesCreatePost /api/v2/engagements/{id}/files/
EngagementsAPIEngagementsFilesDownloadRetrieveGet /api/v2/engagements/{id}/files/download/{file_id}/
EngagementsAPIEngagementsFilesRetrieveGet /api/v2/engagements/{id}/files/
EngagementsAPIEngagementsGenerateReportCreatePost /api/v2/engagements/{id}/generate_report/
EngagementsAPIEngagementsListGet /api/v2/engagements/
EngagementsAPIEngagementsNotesCreatePost /api/v2/engagements/{id}/notes/
EngagementsAPIEngagementsNotesRetrieveGet /api/v2/engagements/{id}/notes/
EngagementsAPIEngagementsPartialUpdatePatch /api/v2/engagements/{id}/
EngagementsAPIEngagementsReopenCreatePost /api/v2/engagements/{id}/reopen/
EngagementsAPIEngagementsRetrieveGet /api/v2/engagements/{id}/
EngagementsAPIEngagementsUpdatePut /api/v2/engagements/{id}/
FindingTemplatesAPIFindingTemplatesCreatePost /api/v2/finding_templates/
FindingTemplatesAPIFindingTemplatesDeletePreviewListGet /api/v2/finding_templates/{id}/delete_preview/
FindingTemplatesAPIFindingTemplatesDestroyDelete /api/v2/finding_templates/{id}/
FindingTemplatesAPIFindingTemplatesListGet /api/v2/finding_templates/
FindingTemplatesAPIFindingTemplatesPartialUpdatePatch /api/v2/finding_templates/{id}/
FindingTemplatesAPIFindingTemplatesRetrieveGet /api/v2/finding_templates/{id}/
FindingTemplatesAPIFindingTemplatesUpdatePut /api/v2/finding_templates/{id}/
FindingsAPIFindingsAcceptRisksCreatePost /api/v2/findings/accept_risks/
FindingsAPIFindingsCloseCreatePost /api/v2/findings/{id}/close/
FindingsAPIFindingsCreatePost /api/v2/findings/
FindingsAPIFindingsDeletePreviewListGet /api/v2/findings/{id}/delete_preview/
FindingsAPIFindingsDestroyDelete /api/v2/findings/{id}/
FindingsAPIFindingsDuplicateListGet /api/v2/findings/{id}/duplicate/
FindingsAPIFindingsDuplicateResetCreatePost /api/v2/findings/{id}/duplicate/reset/
FindingsAPIFindingsFilesCreatePost /api/v2/findings/{id}/files/
FindingsAPIFindingsFilesDownloadRetrieveGet /api/v2/findings/{id}/files/download/{file_id}/
FindingsAPIFindingsFilesRetrieveGet /api/v2/findings/{id}/files/
FindingsAPIFindingsGenerateReportCreatePost /api/v2/findings/generate_report/
FindingsAPIFindingsListGet /api/v2/findings/
FindingsAPIFindingsMetadataCreatePost /api/v2/findings/{id}/metadata/
FindingsAPIFindingsMetadataDestroyDelete /api/v2/findings/{id}/metadata/
FindingsAPIFindingsMetadataListGet /api/v2/findings/{id}/metadata/
FindingsAPIFindingsMetadataUpdatePut /api/v2/findings/{id}/metadata/
FindingsAPIFindingsNotesCreatePost /api/v2/findings/{id}/notes/
FindingsAPIFindingsNotesRetrieveGet /api/v2/findings/{id}/notes/
FindingsAPIFindingsOriginalCreatePost /api/v2/findings/{id}/original/{new_fid}/
FindingsAPIFindingsPartialUpdatePatch /api/v2/findings/{id}/
FindingsAPIFindingsRemoveNotePartialUpdatePatch /api/v2/findings/{id}/remove_note/
FindingsAPIFindingsRemoveTagsPartialUpdatePatch /api/v2/findings/{id}/remove_tags/
FindingsAPIFindingsRemoveTagsUpdatePut /api/v2/findings/{id}/remove_tags/
FindingsAPIFindingsRequestResponseCreatePost /api/v2/findings/{id}/request_response/
FindingsAPIFindingsRequestResponseRetrieveGet /api/v2/findings/{id}/request_response/
FindingsAPIFindingsRetrieveGet /api/v2/findings/{id}/
FindingsAPIFindingsTagsCreatePost /api/v2/findings/{id}/tags/
FindingsAPIFindingsTagsRetrieveGet /api/v2/findings/{id}/tags/
FindingsAPIFindingsUpdatePut /api/v2/findings/{id}/
GlobalRolesAPIGlobalRolesCreatePost /api/v2/global_roles/
GlobalRolesAPIGlobalRolesDeletePreviewListGet /api/v2/global_roles/{id}/delete_preview/
GlobalRolesAPIGlobalRolesDestroyDelete /api/v2/global_roles/{id}/
GlobalRolesAPIGlobalRolesListGet /api/v2/global_roles/
GlobalRolesAPIGlobalRolesPartialUpdatePatch /api/v2/global_roles/{id}/
GlobalRolesAPIGlobalRolesRetrieveGet /api/v2/global_roles/{id}/
GlobalRolesAPIGlobalRolesUpdatePut /api/v2/global_roles/{id}/
ImportLanguagesAPIImportLanguagesCreatePost /api/v2/import-languages/
ImportScanAPIImportScanCreatePost /api/v2/import-scan/
JiraConfigurationsAPIJiraConfigurationsCreatePost /api/v2/jira_configurations/
JiraConfigurationsAPIJiraConfigurationsDeletePreviewListGet /api/v2/jira_configurations/{id}/delete_preview/
JiraConfigurationsAPIJiraConfigurationsDestroyDelete /api/v2/jira_configurations/{id}/
JiraConfigurationsAPIJiraConfigurationsListGet /api/v2/jira_configurations/
JiraConfigurationsAPIJiraConfigurationsPartialUpdatePatch /api/v2/jira_configurations/{id}/
JiraConfigurationsAPIJiraConfigurationsRetrieveGet /api/v2/jira_configurations/{id}/
JiraConfigurationsAPIJiraConfigurationsUpdatePut /api/v2/jira_configurations/{id}/
JiraFindingMappingsAPIJiraFindingMappingsCreatePost /api/v2/jira_finding_mappings/
JiraFindingMappingsAPIJiraFindingMappingsDeletePreviewListGet /api/v2/jira_finding_mappings/{id}/delete_preview/
JiraFindingMappingsAPIJiraFindingMappingsDestroyDelete /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsAPIJiraFindingMappingsListGet /api/v2/jira_finding_mappings/
JiraFindingMappingsAPIJiraFindingMappingsPartialUpdatePatch /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsAPIJiraFindingMappingsRetrieveGet /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsAPIJiraFindingMappingsUpdatePut /api/v2/jira_finding_mappings/{id}/
JiraInstancesAPIJiraInstancesCreatePost /api/v2/jira_instances/
JiraInstancesAPIJiraInstancesDeletePreviewListGet /api/v2/jira_instances/{id}/delete_preview/
JiraInstancesAPIJiraInstancesDestroyDelete /api/v2/jira_instances/{id}/
JiraInstancesAPIJiraInstancesListGet /api/v2/jira_instances/
JiraInstancesAPIJiraInstancesPartialUpdatePatch /api/v2/jira_instances/{id}/
JiraInstancesAPIJiraInstancesRetrieveGet /api/v2/jira_instances/{id}/
JiraInstancesAPIJiraInstancesUpdatePut /api/v2/jira_instances/{id}/
JiraProductConfigurationsAPIJiraProductConfigurationsCreatePost /api/v2/jira_product_configurations/
JiraProductConfigurationsAPIJiraProductConfigurationsDeletePreviewListGet /api/v2/jira_product_configurations/{id}/delete_preview/
JiraProductConfigurationsAPIJiraProductConfigurationsDestroyDelete /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsAPIJiraProductConfigurationsListGet /api/v2/jira_product_configurations/
JiraProductConfigurationsAPIJiraProductConfigurationsPartialUpdatePatch /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsAPIJiraProductConfigurationsRetrieveGet /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsAPIJiraProductConfigurationsUpdatePut /api/v2/jira_product_configurations/{id}/
JiraProjectsAPIJiraProjectsCreatePost /api/v2/jira_projects/
JiraProjectsAPIJiraProjectsDeletePreviewListGet /api/v2/jira_projects/{id}/delete_preview/
JiraProjectsAPIJiraProjectsDestroyDelete /api/v2/jira_projects/{id}/
JiraProjectsAPIJiraProjectsListGet /api/v2/jira_projects/
JiraProjectsAPIJiraProjectsPartialUpdatePatch /api/v2/jira_projects/{id}/
JiraProjectsAPIJiraProjectsRetrieveGet /api/v2/jira_projects/{id}/
JiraProjectsAPIJiraProjectsUpdatePut /api/v2/jira_projects/{id}/
LanguageTypesAPILanguageTypesCreatePost /api/v2/language_types/
LanguageTypesAPILanguageTypesDeletePreviewListGet /api/v2/language_types/{id}/delete_preview/
LanguageTypesAPILanguageTypesDestroyDelete /api/v2/language_types/{id}/
LanguageTypesAPILanguageTypesListGet /api/v2/language_types/
LanguageTypesAPILanguageTypesPartialUpdatePatch /api/v2/language_types/{id}/
LanguageTypesAPILanguageTypesRetrieveGet /api/v2/language_types/{id}/
LanguageTypesAPILanguageTypesUpdatePut /api/v2/language_types/{id}/
LanguagesAPILanguagesCreatePost /api/v2/languages/
LanguagesAPILanguagesDeletePreviewListGet /api/v2/languages/{id}/delete_preview/
LanguagesAPILanguagesDestroyDelete /api/v2/languages/{id}/
LanguagesAPILanguagesListGet /api/v2/languages/
LanguagesAPILanguagesPartialUpdatePatch /api/v2/languages/{id}/
LanguagesAPILanguagesRetrieveGet /api/v2/languages/{id}/
LanguagesAPILanguagesUpdatePut /api/v2/languages/{id}/
MetadataAPIMetadataCreatePost /api/v2/metadata/
MetadataAPIMetadataDeletePreviewListGet /api/v2/metadata/{id}/delete_preview/
MetadataAPIMetadataDestroyDelete /api/v2/metadata/{id}/
MetadataAPIMetadataListGet /api/v2/metadata/
MetadataAPIMetadataPartialUpdatePatch /api/v2/metadata/{id}/
MetadataAPIMetadataRetrieveGet /api/v2/metadata/{id}/
MetadataAPIMetadataUpdatePut /api/v2/metadata/{id}/
NetworkLocationsAPINetworkLocationsCreatePost /api/v2/network_locations/
NetworkLocationsAPINetworkLocationsDeletePreviewListGet /api/v2/network_locations/{id}/delete_preview/
NetworkLocationsAPINetworkLocationsDestroyDelete /api/v2/network_locations/{id}/
NetworkLocationsAPINetworkLocationsListGet /api/v2/network_locations/
NetworkLocationsAPINetworkLocationsPartialUpdatePatch /api/v2/network_locations/{id}/
NetworkLocationsAPINetworkLocationsRetrieveGet /api/v2/network_locations/{id}/
NetworkLocationsAPINetworkLocationsUpdatePut /api/v2/network_locations/{id}/
NoteTypeAPINoteTypeCreatePost /api/v2/note_type/
NoteTypeAPINoteTypeDeletePreviewListGet /api/v2/note_type/{id}/delete_preview/
NoteTypeAPINoteTypeDestroyDelete /api/v2/note_type/{id}/
NoteTypeAPINoteTypeListGet /api/v2/note_type/
NoteTypeAPINoteTypePartialUpdatePatch /api/v2/note_type/{id}/
NoteTypeAPINoteTypeRetrieveGet /api/v2/note_type/{id}/
NoteTypeAPINoteTypeUpdatePut /api/v2/note_type/{id}/
NotesAPINotesListGet /api/v2/notes/
NotesAPINotesPartialUpdatePatch /api/v2/notes/{id}/
NotesAPINotesRetrieveGet /api/v2/notes/{id}/
NotesAPINotesUpdatePut /api/v2/notes/{id}/
NotificationsAPINotificationsCreatePost /api/v2/notifications/
NotificationsAPINotificationsDeletePreviewListGet /api/v2/notifications/{id}/delete_preview/
NotificationsAPINotificationsDestroyDelete /api/v2/notifications/{id}/
NotificationsAPINotificationsListGet /api/v2/notifications/
NotificationsAPINotificationsPartialUpdatePatch /api/v2/notifications/{id}/
NotificationsAPINotificationsRetrieveGet /api/v2/notifications/{id}/
NotificationsAPINotificationsUpdatePut /api/v2/notifications/{id}/
Oa3APIOa3SchemaRetrieveGet /api/v2/oa3/schema/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsCreatePost /api/v2/product_api_scan_configurations/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsDeletePreviewListGet /api/v2/product_api_scan_configurations/{id}/delete_preview/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsDestroyDelete /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsListGet /api/v2/product_api_scan_configurations/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsPartialUpdatePatch /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsRetrieveGet /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsAPIProductApiScanConfigurationsUpdatePut /api/v2/product_api_scan_configurations/{id}/
ProductGroupsAPIProductGroupsCreatePost /api/v2/product_groups/
ProductGroupsAPIProductGroupsDeletePreviewListGet /api/v2/product_groups/{id}/delete_preview/
ProductGroupsAPIProductGroupsDestroyDelete /api/v2/product_groups/{id}/
ProductGroupsAPIProductGroupsListGet /api/v2/product_groups/
ProductGroupsAPIProductGroupsRetrieveGet /api/v2/product_groups/{id}/
ProductGroupsAPIProductGroupsUpdatePut /api/v2/product_groups/{id}/
ProductMembersAPIProductMembersCreatePost /api/v2/product_members/
ProductMembersAPIProductMembersDeletePreviewListGet /api/v2/product_members/{id}/delete_preview/
ProductMembersAPIProductMembersDestroyDelete /api/v2/product_members/{id}/
ProductMembersAPIProductMembersListGet /api/v2/product_members/
ProductMembersAPIProductMembersRetrieveGet /api/v2/product_members/{id}/
ProductMembersAPIProductMembersUpdatePut /api/v2/product_members/{id}/
ProductTypeGroupsAPIProductTypeGroupsCreatePost /api/v2/product_type_groups/
ProductTypeGroupsAPIProductTypeGroupsDeletePreviewListGet /api/v2/product_type_groups/{id}/delete_preview/
ProductTypeGroupsAPIProductTypeGroupsDestroyDelete /api/v2/product_type_groups/{id}/
ProductTypeGroupsAPIProductTypeGroupsListGet /api/v2/product_type_groups/
ProductTypeGroupsAPIProductTypeGroupsRetrieveGet /api/v2/product_type_groups/{id}/
ProductTypeGroupsAPIProductTypeGroupsUpdatePut /api/v2/product_type_groups/{id}/
ProductTypeMembersAPIProductTypeMembersCreatePost /api/v2/product_type_members/
ProductTypeMembersAPIProductTypeMembersDeletePreviewListGet /api/v2/product_type_members/{id}/delete_preview/
ProductTypeMembersAPIProductTypeMembersDestroyDelete /api/v2/product_type_members/{id}/
ProductTypeMembersAPIProductTypeMembersListGet /api/v2/product_type_members/
ProductTypeMembersAPIProductTypeMembersRetrieveGet /api/v2/product_type_members/{id}/
ProductTypeMembersAPIProductTypeMembersUpdatePut /api/v2/product_type_members/{id}/
ProductTypesAPIProductTypesCreatePost /api/v2/product_types/
ProductTypesAPIProductTypesDeletePreviewListGet /api/v2/product_types/{id}/delete_preview/
ProductTypesAPIProductTypesDestroyDelete /api/v2/product_types/{id}/
ProductTypesAPIProductTypesGenerateReportCreatePost /api/v2/product_types/{id}/generate_report/
ProductTypesAPIProductTypesListGet /api/v2/product_types/
ProductTypesAPIProductTypesPartialUpdatePatch /api/v2/product_types/{id}/
ProductTypesAPIProductTypesRetrieveGet /api/v2/product_types/{id}/
ProductTypesAPIProductTypesUpdatePut /api/v2/product_types/{id}/
ProductsAPIProductsCreatePost /api/v2/products/
ProductsAPIProductsDeletePreviewListGet /api/v2/products/{id}/delete_preview/
ProductsAPIProductsDestroyDelete /api/v2/products/{id}/
ProductsAPIProductsGenerateReportCreatePost /api/v2/products/{id}/generate_report/
ProductsAPIProductsListGet /api/v2/products/
ProductsAPIProductsPartialUpdatePatch /api/v2/products/{id}/
ProductsAPIProductsRetrieveGet /api/v2/products/{id}/
ProductsAPIProductsUpdatePut /api/v2/products/{id}/
QuestionnaireAnsweredQuestionnairesAPIQuestionnaireAnsweredQuestionnairesListGet /api/v2/questionnaire_answered_questionnaires/
QuestionnaireAnsweredQuestionnairesAPIQuestionnaireAnsweredQuestionnairesRetrieveGet /api/v2/questionnaire_answered_questionnaires/{id}/
QuestionnaireAnswersAPIQuestionnaireAnswersListGet /api/v2/questionnaire_answers/
QuestionnaireAnswersAPIQuestionnaireAnswersRetrieveGet /api/v2/questionnaire_answers/{id}/
QuestionnaireEngagementQuestionnairesAPIQuestionnaireEngagementQuestionnairesListGet /api/v2/questionnaire_engagement_questionnaires/
QuestionnaireEngagementQuestionnairesAPIQuestionnaireEngagementQuestionnairesRetrieveGet /api/v2/questionnaire_engagement_questionnaires/{id}/
QuestionnaireGeneralQuestionnairesAPIQuestionnaireGeneralQuestionnairesListGet /api/v2/questionnaire_general_questionnaires/
QuestionnaireGeneralQuestionnairesAPIQuestionnaireGeneralQuestionnairesRetrieveGet /api/v2/questionnaire_general_questionnaires/{id}/
QuestionnaireQuestionsAPIQuestionnaireQuestionsListGet /api/v2/questionnaire_questions/
QuestionnaireQuestionsAPIQuestionnaireQuestionsRetrieveGet /api/v2/questionnaire_questions/{id}/
RegulationsAPIRegulationsCreatePost /api/v2/regulations/
RegulationsAPIRegulationsDeletePreviewListGet /api/v2/regulations/{id}/delete_preview/
RegulationsAPIRegulationsDestroyDelete /api/v2/regulations/{id}/
RegulationsAPIRegulationsListGet /api/v2/regulations/
RegulationsAPIRegulationsPartialUpdatePatch /api/v2/regulations/{id}/
RegulationsAPIRegulationsRetrieveGet /api/v2/regulations/{id}/
RegulationsAPIRegulationsUpdatePut /api/v2/regulations/{id}/
ReimportScanAPIReimportScanCreatePost /api/v2/reimport-scan/
RiskAcceptanceAPIRiskAcceptanceCreatePost /api/v2/risk_acceptance/
RiskAcceptanceAPIRiskAcceptanceDeletePreviewListGet /api/v2/risk_acceptance/{id}/delete_preview/
RiskAcceptanceAPIRiskAcceptanceDestroyDelete /api/v2/risk_acceptance/{id}/
RiskAcceptanceAPIRiskAcceptanceDownloadProofRetrieveGet /api/v2/risk_acceptance/{id}/download_proof/
RiskAcceptanceAPIRiskAcceptanceListGet /api/v2/risk_acceptance/
RiskAcceptanceAPIRiskAcceptancePartialUpdatePatch /api/v2/risk_acceptance/{id}/
RiskAcceptanceAPIRiskAcceptanceRetrieveGet /api/v2/risk_acceptance/{id}/
RiskAcceptanceAPIRiskAcceptanceUpdatePut /api/v2/risk_acceptance/{id}/
RolesAPIRolesListGet /api/v2/roles/
RolesAPIRolesRetrieveGet /api/v2/roles/{id}/
SlaConfigurationsAPISlaConfigurationsCreatePost /api/v2/sla_configurations/
SlaConfigurationsAPISlaConfigurationsDeletePreviewListGet /api/v2/sla_configurations/{id}/delete_preview/
SlaConfigurationsAPISlaConfigurationsDestroyDelete /api/v2/sla_configurations/{id}/
SlaConfigurationsAPISlaConfigurationsListGet /api/v2/sla_configurations/
SlaConfigurationsAPISlaConfigurationsPartialUpdatePatch /api/v2/sla_configurations/{id}/
SlaConfigurationsAPISlaConfigurationsRetrieveGet /api/v2/sla_configurations/{id}/
SlaConfigurationsAPISlaConfigurationsUpdatePut /api/v2/sla_configurations/{id}/
SonarqubeIssuesAPISonarqubeIssuesCreatePost /api/v2/sonarqube_issues/
SonarqubeIssuesAPISonarqubeIssuesDeletePreviewListGet /api/v2/sonarqube_issues/{id}/delete_preview/
SonarqubeIssuesAPISonarqubeIssuesDestroyDelete /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesAPISonarqubeIssuesListGet /api/v2/sonarqube_issues/
SonarqubeIssuesAPISonarqubeIssuesPartialUpdatePatch /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesAPISonarqubeIssuesRetrieveGet /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesAPISonarqubeIssuesUpdatePut /api/v2/sonarqube_issues/{id}/
SonarqubeTransitionsAPISonarqubeTransitionsCreatePost /api/v2/sonarqube_transitions/
SonarqubeTransitionsAPISonarqubeTransitionsDeletePreviewListGet /api/v2/sonarqube_transitions/{id}/delete_preview/
SonarqubeTransitionsAPISonarqubeTransitionsDestroyDelete /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsAPISonarqubeTransitionsListGet /api/v2/sonarqube_transitions/
SonarqubeTransitionsAPISonarqubeTransitionsPartialUpdatePatch /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsAPISonarqubeTransitionsRetrieveGet /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsAPISonarqubeTransitionsUpdatePut /api/v2/sonarqube_transitions/{id}/
StubFindingsAPIStubFindingsCreatePost /api/v2/stub_findings/
StubFindingsAPIStubFindingsDeletePreviewListGet /api/v2/stub_findings/{id}/delete_preview/
StubFindingsAPIStubFindingsDestroyDelete /api/v2/stub_findings/{id}/
StubFindingsAPIStubFindingsListGet /api/v2/stub_findings/
StubFindingsAPIStubFindingsPartialUpdatePatch /api/v2/stub_findings/{id}/
StubFindingsAPIStubFindingsRetrieveGet /api/v2/stub_findings/{id}/
StubFindingsAPIStubFindingsUpdatePut /api/v2/stub_findings/{id}/
SystemSettingsAPISystemSettingsListGet /api/v2/system_settings/
SystemSettingsAPISystemSettingsPartialUpdatePatch /api/v2/system_settings/{id}/
SystemSettingsAPISystemSettingsUpdatePut /api/v2/system_settings/{id}/
TechnologiesAPITechnologiesCreatePost /api/v2/technologies/
TechnologiesAPITechnologiesDeletePreviewListGet /api/v2/technologies/{id}/delete_preview/
TechnologiesAPITechnologiesDestroyDelete /api/v2/technologies/{id}/
TechnologiesAPITechnologiesListGet /api/v2/technologies/
TechnologiesAPITechnologiesPartialUpdatePatch /api/v2/technologies/{id}/
TechnologiesAPITechnologiesRetrieveGet /api/v2/technologies/{id}/
TechnologiesAPITechnologiesUpdatePut /api/v2/technologies/{id}/
TestImportsAPITestImportsCreatePost /api/v2/test_imports/
TestImportsAPITestImportsDeletePreviewListGet /api/v2/test_imports/{id}/delete_preview/
TestImportsAPITestImportsDestroyDelete /api/v2/test_imports/{id}/
TestImportsAPITestImportsListGet /api/v2/test_imports/
TestImportsAPITestImportsPartialUpdatePatch /api/v2/test_imports/{id}/
TestImportsAPITestImportsRetrieveGet /api/v2/test_imports/{id}/
TestImportsAPITestImportsUpdatePut /api/v2/test_imports/{id}/
TestTypesAPITestTypesCreatePost /api/v2/test_types/
TestTypesAPITestTypesListGet /api/v2/test_types/
TestTypesAPITestTypesPartialUpdatePatch /api/v2/test_types/{id}/
TestTypesAPITestTypesRetrieveGet /api/v2/test_types/{id}/
TestTypesAPITestTypesUpdatePut /api/v2/test_types/{id}/
TestsAPITestsAcceptRisksCreatePost /api/v2/tests/{id}/accept_risks/
TestsAPITestsCreatePost /api/v2/tests/
TestsAPITestsDeletePreviewListGet /api/v2/tests/{id}/delete_preview/
TestsAPITestsDestroyDelete /api/v2/tests/{id}/
TestsAPITestsFilesCreatePost /api/v2/tests/{id}/files/
TestsAPITestsFilesDownloadRetrieveGet /api/v2/tests/{id}/files/download/{file_id}/
TestsAPITestsFilesRetrieveGet /api/v2/tests/{id}/files/
TestsAPITestsGenerateReportCreatePost /api/v2/tests/{id}/generate_report/
TestsAPITestsListGet /api/v2/tests/
TestsAPITestsNotesCreatePost /api/v2/tests/{id}/notes/
TestsAPITestsNotesRetrieveGet /api/v2/tests/{id}/notes/
TestsAPITestsPartialUpdatePatch /api/v2/tests/{id}/
TestsAPITestsRetrieveGet /api/v2/tests/{id}/
TestsAPITestsUpdatePut /api/v2/tests/{id}/
ToolConfigurationsAPIToolConfigurationsCreatePost /api/v2/tool_configurations/
ToolConfigurationsAPIToolConfigurationsDeletePreviewListGet /api/v2/tool_configurations/{id}/delete_preview/
ToolConfigurationsAPIToolConfigurationsDestroyDelete /api/v2/tool_configurations/{id}/
ToolConfigurationsAPIToolConfigurationsListGet /api/v2/tool_configurations/
ToolConfigurationsAPIToolConfigurationsPartialUpdatePatch /api/v2/tool_configurations/{id}/
ToolConfigurationsAPIToolConfigurationsRetrieveGet /api/v2/tool_configurations/{id}/
ToolConfigurationsAPIToolConfigurationsUpdatePut /api/v2/tool_configurations/{id}/
ToolProductSettingsAPIToolProductSettingsCreatePost /api/v2/tool_product_settings/
ToolProductSettingsAPIToolProductSettingsDeletePreviewListGet /api/v2/tool_product_settings/{id}/delete_preview/
ToolProductSettingsAPIToolProductSettingsDestroyDelete /api/v2/tool_product_settings/{id}/
ToolProductSettingsAPIToolProductSettingsListGet /api/v2/tool_product_settings/
ToolProductSettingsAPIToolProductSettingsPartialUpdatePatch /api/v2/tool_product_settings/{id}/
ToolProductSettingsAPIToolProductSettingsRetrieveGet /api/v2/tool_product_settings/{id}/
ToolProductSettingsAPIToolProductSettingsUpdatePut /api/v2/tool_product_settings/{id}/
ToolTypesAPIToolTypesCreatePost /api/v2/tool_types/
ToolTypesAPIToolTypesDeletePreviewListGet /api/v2/tool_types/{id}/delete_preview/
ToolTypesAPIToolTypesDestroyDelete /api/v2/tool_types/{id}/
ToolTypesAPIToolTypesListGet /api/v2/tool_types/
ToolTypesAPIToolTypesPartialUpdatePatch /api/v2/tool_types/{id}/
ToolTypesAPIToolTypesRetrieveGet /api/v2/tool_types/{id}/
ToolTypesAPIToolTypesUpdatePut /api/v2/tool_types/{id}/
UserContactInfosAPIUserContactInfosCreatePost /api/v2/user_contact_infos/
UserContactInfosAPIUserContactInfosDeletePreviewListGet /api/v2/user_contact_infos/{id}/delete_preview/
UserContactInfosAPIUserContactInfosDestroyDelete /api/v2/user_contact_infos/{id}/
UserContactInfosAPIUserContactInfosListGet /api/v2/user_contact_infos/
UserContactInfosAPIUserContactInfosPartialUpdatePatch /api/v2/user_contact_infos/{id}/
UserContactInfosAPIUserContactInfosRetrieveGet /api/v2/user_contact_infos/{id}/
UserContactInfosAPIUserContactInfosUpdatePut /api/v2/user_contact_infos/{id}/
UserProfileAPIUserProfileRetrieveGet /api/v2/user_profile/
UsersAPIUsersCreatePost /api/v2/users/
UsersAPIUsersDeletePreviewListGet /api/v2/users/{id}/delete_preview/
UsersAPIUsersDestroyDelete /api/v2/users/{id}/
UsersAPIUsersListGet /api/v2/users/
UsersAPIUsersPartialUpdatePatch /api/v2/users/{id}/
UsersAPIUsersRetrieveGet /api/v2/users/{id}/
UsersAPIUsersUpdatePut /api/v2/users/{id}/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), defectdojo.ContextBasicAuth, defectdojo.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: cookieAuth and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		defectdojo.ContextAPIKeys,
		map[string]defectdojo.APIKey{
			"cookieAuth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: tokenAuth and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		defectdojo.ContextAPIKeys,
		map[string]defectdojo.APIKey{
			"tokenAuth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author