8000 GitHub - StL-Jim/defectdojo-api-v2-client: DefectDojo API v2 Client, generated from openapi
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

StL-Jim/defectdojo-api-v2-client

BranchesTags

Repository files navigation

defectdojo-api-v2-client

To use the API you need be authorized.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v2
  • Package version: 0.0.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.defectdojo.org/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://demo.defectdojo.org/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration = openapi_client.Configuration(
    host = "https://demo.defectdojo.org/api/v2",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ApiTokenAuthApi(api_client)
    data = openapi_client.AuthToken() # AuthToken | 

    try:
        api_response = api_instance.api_token_auth_create(data)
        pprint(api_response)
    e
6DB6
xcept ApiException as e:
        print("Exception when calling ApiTokenAuthApi->api_token_auth_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://demo.defectdojo.org/api/v2

Class Method HTTP request Description
ApiTokenAuthApi api_token_auth_create POST /api-token-auth/
DevelopmentEnvironmentsApi development_environments_create POST /development_environments/
DevelopmentEnvironmentsApi development_environments_delete DELETE /development_environments/{id}/
DevelopmentEnvironmentsApi development_environments_list GET /development_environments/
DevelopmentEnvironmentsApi development_environments_partial_update PATCH /development_environments/{id}/
DevelopmentEnvironmentsApi development_environments_read GET /development_environments/{id}/
DevelopmentEnvironmentsApi development_environments_update PUT /development_environments/{id}/
DojoGroupMembersApi dojo_group_members_create POST /dojo_group_members/
DojoGroupMembersApi dojo_group_members_delete DELETE /dojo_group_members/{id}/
DojoGroupMembersApi dojo_group_members_list GET /dojo_group_members/
DojoGroupMembersApi dojo_group_members_partial_update PATCH /dojo_group_members/{id}/
DojoGroupMembersApi dojo_group_members_read GET /dojo_group_members/{id}/
DojoGroupMembersApi dojo_group_members_update PUT /dojo_group_members/{id}/
DojoGroupsApi dojo_groups_create POST /dojo_groups/
DojoGroupsApi dojo_groups_delete DELETE /dojo_groups/{id}/
DojoGroupsApi dojo_groups_list GET /dojo_groups/
DojoGroupsApi dojo_groups_partial_update PATCH /dojo_groups/{id}/
DojoGroupsApi dojo_groups_read GET /dojo_groups/{id}/
DojoGroupsApi dojo_groups_update PUT /dojo_groups/{id}/
EndpointMetaImportApi endpoint_meta_import_create POST /endpoint_meta_import/ Imports a CSV file into a product to propogate arbitrary meta and tags on endpoints.
EndpointStatusApi endpoint_status_create POST /endpoint_status/
EndpointStatusApi endpoint_status_delete DELETE /endpoint_status/{id}/
EndpointStatusApi endpoint_status_list GET /endpoint_status/
EndpointStatusApi endpoint_status_partial_update PATCH /endpoint_status/{id}/
EndpointStatusApi endpoint_status_read GET /endpoint_status/{id}/
EndpointStatusApi endpoint_status_update PUT /endpoint_status/{id}/
EndpointsApi endpoints_create POST /endpoints/
EndpointsApi endpoints_delete DELETE /endpoints/{id}/
EndpointsApi endpoints_generate_report POST /endpoints/{id}/generate_report/
EndpointsApi endpoints_list GET /endpoints/
EndpointsApi endpoints_partial_update PATCH /endpoints/{id}/
EndpointsApi endpoints_read GET /endpoints/{id}/
EndpointsApi endpoints_update PUT /endpoints/{id}/
EngagementPresetsApi engagement_presets_create POST /engagement_presets/
EngagementPresetsApi engagement_presets_delete DELETE /engagement_presets/{id}/
EngagementPresetsApi engagement_presets_list GET /engagement_presets/
EngagementPresetsApi engagement_presets_partial_update PATCH /engagement_presets/{id}/
EngagementPresetsApi engagement_presets_read GET /engagement_presets/{id}/
EngagementPresetsApi engagement_presets_update PUT /engagement_presets/{id}/
EngagementsApi engagements_accept_risks POST /engagements/{id}/accept_risks/
EngagementsApi engagements_close POST /engagements/{id}/close/
EngagementsApi engagements_create POST /engagements/
EngagementsApi engagements_delete DELETE /engagements/{id}/
EngagementsApi engagements_files_create POST /engagements/{id}/files/
EngagementsApi engagements_files_read GET /engagements/{id}/files/
EngagementsApi engagements_generate_report POST /engagements/{id}/generate_report/
EngagementsApi engagements_list GET /engagements/
EngagementsApi engagements_notes_create POST /engagements/{id}/notes/
EngagementsApi engagements_notes_read GET /engagements/{id}/notes/
EngagementsApi engagements_partial_update PATCH /engagements/{id}/
EngagementsApi engagements_read GET /engagements/{id}/
EngagementsApi engagements_reopen POST /engagements/{id}/reopen/
EngagementsApi engagements_update PUT /engagements/{id}/
FindingTemplatesApi finding_templates_create POST /finding_templates/
FindingTemplatesApi finding_templates_delete DELETE /finding_templates/{id}/
FindingTemplatesApi finding_templates_list GET /finding_templates/
FindingTemplatesApi finding_templates_partial_update PATCH /finding_templates/{id}/
FindingTemplatesApi finding_templates_read GET /finding_templates/{id}/
FindingTemplatesApi finding_templates_update PUT /finding_templates/{id}/
FindingsApi findings_accept_risks POST /findings/accept_risks/
FindingsApi findings_create POST /findings/
FindingsApi findings_delete DELETE /findings/{id}/
FindingsApi findings_duplicate_reset_finding_duplicate_status POST /findings/{id}/duplicate/reset/
FindingsApi findings_files_create POST /findings/{id}/files/
FindingsApi findings_files_read GET /findings/{id}/files/
FindingsApi findings_generate_report POST /findings/generate_report/
FindingsApi findings_get_duplicate_cluster GET /findings/{id}/duplicate/
FindingsApi findings_list GET /findings/
FindingsApi findings_metadata_create POST /findings/{id}/metadata/
FindingsApi findings_metadata_delete DELETE /findings/{id}/metadata/
FindingsApi findings_metadata_read GET /findings/{id}/metadata/
FindingsApi findings_metadata_update PUT /findings/{id}/metadata/
FindingsApi findings_notes_create POST /findings/{id}/notes/
FindingsApi findings_notes_read GET /findings/{id}/notes/
FindingsApi findings_partial_update PATCH /findings/{id}/
FindingsApi findings_read GET /findings/{id}/
FindingsApi findings_remove_note PATCH /findings/{id}/remove_note/
FindingsApi findings_remove_tags_partial_update PATCH /findings/{id}/remove_tags/
FindingsApi findings_remove_tags_update PUT /findings/{id}/remove_tags/
FindingsApi findings_request_response_create POST /findings/{id}/request_response/
FindingsApi findings_request_response_read GET /findings/{id}/request_response/
FindingsApi findings_set_finding_as_original POST /findings/{id}/original/{new_fid}/
FindingsApi findings_tags_create POST /findings/{id}/tags/
FindingsApi findings_tags_read GET /findings/{id}/tags/
FindingsApi findings_update PUT /findings/{id}/
GlobalRolesApi global_roles_create POST /global_roles/
GlobalRolesApi global_roles_delete DELETE /global_roles/{id}/
GlobalRolesApi global_roles_list GET /global_roles/
GlobalRolesApi global_roles_partial_update PATCH /global_roles/{id}/
GlobalRolesApi global_roles_read GET /global_roles/{id}/
GlobalRolesApi global_roles_update PUT /global_roles/{id}/
ImportLanguagesApi import_languages_create POST /import-languages/
ImportScanApi import_scan_create POST /import-scan/ Imports a scan report into an engagement or product.
JiraConfigurationsApi jira_configurations_create POST /jira_configurations/
JiraConfigurationsApi jira_configurations_delete DELETE /jira_configurations/{id}/
JiraConfigurationsApi jira_configurations_list GET /jira_configurations/
JiraConfigurationsApi jira_configurations_partial_update PATCH /jira_configurations/{id}/
JiraConfigurationsApi jira_configurations_read GET /jira_configurations/{id}/
JiraConfigurationsApi jira_configurations_update PUT /jira_configurations/{id}/
JiraFindingMappingsApi jira_finding_mappings_create POST /jira_finding_mappings/
JiraFindingMappingsApi jira_finding_mappings_delete DELETE /jira_finding_mappings/{id}/
JiraFindingMappingsApi jira_finding_mappings_list GET /jira_finding_mappings/
JiraFindingMappingsApi jira_finding_mappings_partial_update PATCH /jira_finding_mappings/{id}/
JiraFindingMappingsApi jira_finding_mappings_read GET /jira_finding_mappings/{id}/
JiraFindingMappingsApi jira_finding_mappings_update PUT /jira_finding_mappings/{id}/
JiraInstancesApi jira_instances_create POST /jira_instances/
JiraInstancesApi jira_instances_delete DELETE /jira_instances/{id}/
JiraInstancesApi jira_instances_list GET /jira_instances/
JiraInstancesApi jira_instances_partial_update PATCH /jira_instances/{id}/
JiraInstancesApi jira_instances_read GET /jira_instances/{id}/
JiraInstancesApi jira_instances_update PUT /jira_instances/{id}/
JiraProductConfigurationsApi jira_product_configurations_create POST /jira_product_configurations/
JiraProductConfigurationsApi jira_product_configurations_delete DELETE /jira_product_configurations/{id}/
JiraProductConfigurationsApi jira_product_configurations_list GET /jira_product_configurations/
JiraProductConfigurationsApi jira_product_configurations_partial_update PATCH /jira_product_configurations/{id}/
JiraProductConfigurationsApi jira_product_configurations_read GET /jira_product_configurations/{id}/
JiraProductConfigurationsApi jira_product_configurations_update PUT /jira_product_configurations/{id}/
JiraProjectsApi jira_projects_create POST /jira_projects/
JiraProjectsApi jira_projects_delete DELETE /jira_projects/{id}/
JiraProjectsApi jira_projects_list GET /jira_projects/
JiraProjectsApi jira_projects_partial_update PATCH /jira_projects/{id}/
JiraProjectsApi jira_projects_read GET /jira_projects/{id}/
JiraProjectsApi jira_projects_update PUT /jira_projects/{id}/
LanguageTypesApi language_types_create POST /language_types/
LanguageTypesApi language_types_delete DELETE /language_types/{id}/
LanguageTypesApi language_types_list GET /language_types/
LanguageTypesApi language_types_partial_update PATCH /language_types/{id}/
LanguageTypesApi language_types_read GET /language_types/{id}/
LanguageTypesApi language_types_update PUT /language_types/{id}/
LanguagesApi languages_create POST /languages/
LanguagesApi languages_delete DELETE /languages/{id}/
LanguagesApi languages_list GET /languages/
LanguagesApi languages_partial_update PATCH /languages/{id}/
LanguagesApi languages_read GET /languages/{id}/
LanguagesApi languages_update PUT /languages/{id}/
MetadataApi metadata_create POST /metadata/
MetadataApi metadata_delete DELETE /metadata/{id}/
MetadataApi metadata_list GET /metadata/
MetadataApi metadata_partial_update PATCH /metadata/{id}/
MetadataApi metadata_read GET /metadata/{id}/
MetadataApi metadata_update PUT /metadata/{id}/
NetworkLocationsApi network_locations_create POST /network_locations/
NetworkLocationsApi network_locations_delete DELETE /network_locations/{id}/
NetworkLocationsApi network_locations_list GET /network_locations/
NetworkLocationsApi network_locations_partial_update PATCH /network_locations/{id}/
NetworkLocationsApi network_locations_read GET /network_locations/{id}/
NetworkLocationsApi network_locations_update PUT /network_locations/{id}/
NoteTypeApi note_type_create POST /note_type/
NoteTypeApi note_type_delete DELETE /note_type/{id}/
NoteTypeApi note_type_list GET /note_type/
NoteTypeApi note_type_partial_update PATCH /note_type/{id}/
NoteTypeApi note_type_read GET /note_type/{id}/
NoteTypeApi note_type_update PUT /note_type/{id}/
NotesApi notes_list GET /notes/
NotesApi notes_partial_update PATCH /notes/{id}/
NotesApi notes_read GET /notes/{id}/
NotesApi notes_update PUT /notes/{id}/
NotificationsApi notifications_create POST /notifications/
NotificationsApi notifications_delete DELETE /notifications/{id}/
NotificationsApi notifications_list GET /notifications/
NotificationsApi notifications_partial_update PATCH /notifications/{id}/
NotificationsApi notifications_read GET /notifications/{id}/
NotificationsApi notifications_update PUT /notifications/{id}/
Oa3Api oa3_schema_list GET /oa3/schema/ OpenApi3 schema for this API. Format can be selected via content negotiation.
Oa3Api oa3_swagger_ui_list GET /oa3/swagger-ui/
ProductApiScanConfigurationsApi product_api_scan_configurations_create POST /product_api_scan_configurations/
ProductApiScanConfigurationsApi product_api_scan_configurations_delete DELETE /product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi product_api_scan_configurations_list GET /product_api_scan_configurations/
ProductApiScanConfigurationsApi product_api_scan_configurations_partial_update PATCH /product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi product_api_scan_configurations_read GET /product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi product_api_scan_configurations_update PUT /product_api_scan_configurations/{id}/
ProductGroupsApi product_groups_create POST /product_groups/
ProductGroupsApi product_groups_delete DELETE /product_groups/{id}/
ProductGroupsApi product_groups_list GET /product_groups/
ProductGroupsApi product_groups_partial_update PATCH /product_groups/{id}/
ProductGroupsApi product_groups_read GET /product_groups/{id}/
ProductGroupsApi product_groups_update PUT /product_groups/{id}/
ProductMembersApi product_members_create POST /product_members/
ProductMembersApi product_members_delete DELETE /product_members/{id}/
ProductMembersApi product_members_list GET /product_members/
ProductMembersApi product_members_partial_update PATCH /product_members/{id}/
ProductMembersApi product_members_read GET /product_members/{id}/
ProductMembersApi product_members_update PUT /product_members/{id}/
ProductTypeGroupsApi product_type_groups_create POST /product_type_groups/
ProductTypeGroupsApi product_type_groups_delete DELETE /product_type_groups/{id}/
ProductTypeGroupsApi product_type_groups_list GET /product_type_groups/
ProductTypeGroupsApi product_type_groups_partial_update PATCH /product_type_groups/{id}/
ProductTypeGroupsApi product_type_groups_read GET /product_type_groups/{id}/
ProductTypeGroupsApi product_type_groups_update PUT /product_type_groups/{id}/
ProductTypeMembersApi product_type_members_create POST /product_type_members/
ProductTypeMembersApi product_type_members_delete DELETE /product_type_members/{id}/
ProductTypeMembersApi product_type_members_list GET /product_type_members/
ProductTypeMembersApi product_type_members_partial_update PATCH /product_type_members/{id}/
ProductTypeMembersApi product_type_members_read GET /product_type_members/{id}/
ProductTypeMembersApi product_type_members_update PUT /product_type_members/{id}/
ProductTypesApi product_types_create POST /product_types/
ProductTypesApi product_types_delete DELETE /product_types/{id}/
ProductTypesApi product_types_generate_report POST /product_types/{id}/generate_report/
ProductTypesApi product_types_list GET /product_types/
ProductTypesApi product_types_partial_update PATCH /product_types/{id}/
ProductTypesApi product_types_read GET /product_types/{id}/
ProductTypesApi product_types_update PUT /product_types/{id}/
ProductsApi products_create POST /products/
ProductsApi products_delete DELETE /products/{id}/
ProductsApi products_generate_report POST /products/{id}/generate_report/
ProductsApi products_list GET /products/
ProductsApi products_partial_update PATCH /products/{id}/
ProductsApi products_read GET /products/{id}/
ProductsApi products_update PUT /products/{id}/
RegulationsApi regulations_create POST /regulations/
RegulationsApi regulations_delete DELETE /regulations/{id}/
RegulationsApi regulations_list GET /regulations/
RegulationsApi regulations_partial_update PATCH /regulations/{id}/
RegulationsApi regulations_read GET /regulations/{id}/
RegulationsApi regulations_update PUT /regulations/{id}/
ReimportScanApi reimport_scan_create POST /reimport-scan/ Reimports a scan report into an existing test.
RolesApi roles_list GET /roles/
RolesApi roles_read GET /roles/{id}/
SonarqubeIssuesApi sonarqube_issues_create POST /sonarqube_issues/
SonarqubeIssuesApi sonarqube_issues_delete DELETE /sonarqube_issues/{id}/
SonarqubeIssuesApi sonarqube_issues_list GET /sonarqube_issues/
SonarqubeIssuesApi sonarqube_issues_partial_update PATCH /sonarqube_issues/{id}/
SonarqubeIssuesApi sonarqube_issues_read GET /sonarqube_issues/{id}/
SonarqubeIssuesApi sonarqube_issues_update PUT /sonarqube_issues/{id}/
SonarqubeTransitionsApi sonarqube_transitions_create POST /sonarqube_transitions/
SonarqubeTransitionsApi sonarqube_transitions_delete DELETE /sonarqube_transitions/{id}/
SonarqubeTransitionsApi sonarqube_transitions_list GET /sonarqube_transitions/
SonarqubeTransitionsApi sonarqube_transitions_partial_update PATCH /sonarqube_transitions/{id}/
SonarqubeTransitionsApi sonarqube_transitions_read GET /sonarqube_transitions/{id}/
SonarqubeTransitionsApi sonarqube_transitions_update PUT /sonarqube_transitions/{id}/
StubFindingsApi stub_findings_create POST /stub_findings/
StubFindingsApi stub_findings_delete DELETE /stub_findings/{id}/
StubFindingsApi stub_findings_list GET /stub_findings/
StubFindingsApi stub_findings_partial_update PATCH /stub_findings/{id}/
StubFindingsApi stub_findings_read GET /stub_findings/{id}/
StubFindingsApi stub_findings_update PUT /stub_findings/{id}/
SystemSettingsApi system_settings_list GET /system_settings/
SystemSettingsApi system_settings_partial_update PATCH /system_settings/{id}/
SystemSettingsApi system_settings_update PUT /system_settings/{id}/
TechnologiesApi technologies_create POST /technologies/
TechnologiesApi technologies_delete DELETE /technologies/{id}/
TechnologiesApi technologies_list GET /technologies/
TechnologiesApi technologies_partial_update PATCH /technologies/{id}/
TechnologiesApi technologies_read GET /technologies/{id}/
TechnologiesApi technologies_update PUT /technologies/{id}/
TestImportsApi test_imports_create POST /test_imports/
TestImportsApi test_imports_delete DELETE /test_imports/{id}/
TestImportsApi test_imports_list GET /test_imports/
TestImportsApi test_imports_partial_update PATCH /test_imports/{id}/
TestImportsApi test_imports_read GET /test_imports/{id}/
TestImportsApi test_imports_update PUT /test_imports/{id}/
TestTypesApi test_types_create POST /test_types/
TestTypesApi test_types_list GET /test_types/
TestTypesApi test_types_partial_update PATCH /test_types/{id}/
TestTypesApi test_types_read GET /test_types/{id}/
TestTypesApi test_types_update PUT /test_types/{id}/
TestsApi tests_accept_risks POST /tests/{id}/accept_risks/
TestsApi tests_create POST /tests/
TestsApi tests_delete DELETE /tests/{id}/
TestsApi tests_files_create POST /tests/{id}/files/
TestsApi tests_files_read GET /tests/{id}/files/
TestsApi tests_generate_report POST /tests/{id}/generate_report/
TestsApi tests_list GET /tests/
TestsApi tests_notes_create POST /tests/{id}/notes/
TestsApi tests_notes_read GET /tests/{id}/notes/
TestsApi tests_partial_update PATCH /tests/{id}/
TestsApi tests_read GET /tests/{id}/
TestsApi tests_update PUT /tests/{id}/
ToolConfigurationsApi tool_configurations_create POST /tool_configurations/
ToolConfigurationsApi tool_configurations_delete DELETE /tool_configurations/{id}/
ToolConfigurationsApi tool_configurations_list GET /tool_configurations/
ToolConfigurationsApi tool_configurations_partial_update PATCH /tool_configurations/{id}/
ToolConfigurationsApi tool_configurations_read GET /tool_configurations/{id}/
ToolConfigurationsApi tool_configurations_update PUT /tool_configurations/{id}/
ToolProductSettingsApi tool_product_settings_create POST /tool_product_settings/
ToolProductSettingsApi tool_product_settings_delete DELETE /tool_product_settings/{id}/
ToolProductSettingsApi tool_product_settings_list GET /tool_product_settings/
ToolProductSettingsApi tool_product_settings_partial_update PATCH /tool_product_settings/{id}/
ToolProductSettingsApi tool_product_settings_read GET /tool_product_settings/{id}/
ToolProductSettingsApi tool_product_settings_update PUT /tool_product_settings/{id}/
ToolTypesApi tool_types_create POST /tool_types/
ToolTypesApi tool_types_delete DELETE /tool_types/{id}/
ToolTypesApi tool_types_list GET /tool_types/
ToolTypesApi tool_types_partial_update PATCH /tool_types/{id}/
ToolTypesApi tool_types_read GET /tool_types/{id}/
ToolTypesApi tool_types_update PUT /tool_types/{id}/
UserContactInfosApi user_contact_infos_create POST /user_contact_infos/
UserContactInfosApi user_contact_infos_delete DELETE /user_contact_infos/{id}/
UserContactInfosApi user_contact_infos_list GET /user_contact_infos/
UserContactInfosApi user_contact_infos_partial_update PATCH /user_contact_infos/{id}/
UserContactInfosApi user_contact_infos_read GET /user_contact_infos/{id}/
UserContactInfosApi user_contact_infos_update PUT /user_contact_infos/{id}/
UserProfileApi user_profile_list GET /user_profile/
UsersApi users_create POST /users/
UsersApi users_delete DELETE /users/{id}/
UsersApi users_list GET /users/
UsersApi users_partial_update PATCH /users/{id}/
UsersApi users_read GET /users/{id}/
UsersApi users_update PUT /users/{id}/

Documentation For Models

Documentation For Authorization

api_key

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

Author

About

DefectDojo API v2 Client, generated from openapi

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages
0