Skip to content

RiskPatternsApi

Jump to bottom
Víctor Cañizares edited this page Dec 14, 2020 · 1 revision

RiskPatternsApi

All URIs are relative to https://demo.iriusrisk.com/api/v1

Method HTTP request Description
librariesLibraryRefRiskpatternsPost POST /libraries/{libraryRef}/riskpatterns Creates new Risk Pattern
librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/countermeasures Creates new countermeasure in a risk pattern
librariesLibraryRefRiskpatternsRiskPatternRefDelete DELETE /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Deletes a Risk Pattern
librariesLibraryRefRiskpatternsRiskPatternRefGet GET /libraries/{libraryRef}/riskpatterns/{riskPatternRef} Gets Risk Pattern details
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses Associates weakness to a threat in a risk pattern.
librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut PUT /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/usecases/{useCaseRef}/threats/{threatRef}/weaknesses/{weaknessRef}/countermeasures Associates a countermeasure to a weakness in a risk pattern.
librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost POST /libraries/{libraryRef}/riskpatterns/{riskPatternRef}/weaknesses Creates a new weakness in a risk pattern

librariesLibraryRefRiskpatternsPost

RiskPattern librariesLibraryRefRiskpatternsPost(apiToken, libraryRef, createRiskPatternRequestBody)

Creates new Risk Pattern

Creates new Risk Pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
CreateRiskPatternRequestBody createRiskPatternRequestBody = new CreateRiskPatternRequestBody(); // CreateRiskPatternRequestBody | JSON data that contains information of the fields
try {
    RiskPattern result = apiInstance.librariesLibraryRefRiskpatternsPost(apiToken, libraryRef, createRiskPatternRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
createRiskPatternRequestBody CreateRiskPatternRequestBody JSON data that contains information of the fields

Return type

RiskPattern

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost

LibraryControl librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost(apiToken, libraryRef, riskPatternRef, createCountermeasureLibraryRequestBody)

Creates new countermeasure in a risk pattern

Creates new countermeasure in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
ControlCommand createCountermeasureLibraryRequestBody = new ControlCommand(); // ControlCommand | JSON data that contains information of the fields
try {
    LibraryControl result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost(apiToken, libraryRef, riskPatternRef, createCountermeasureLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefCountermeasuresPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
createCountermeasureLibraryRequestBody ControlCommand JSON data that contains information of the fields

Return type

LibraryControl

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefDelete

librariesLibraryRefRiskpatternsRiskPatternRefDelete(apiToken, libraryRef, riskPatternRef)

Deletes a Risk Pattern

Deletes a Risk Pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
try {
    apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefDelete(apiToken, libraryRef, riskPatternRef);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefGet

RiskPattern librariesLibraryRefRiskpatternsRiskPatternRefGet(apiToken, libraryRef, riskPatternRef)

Gets Risk Pattern details

Gets Risk Pattern details. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
try {
    RiskPattern result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefGet(apiToken, libraryRef, riskPatternRef);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern

Return type

RiskPattern

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut

LibraryWeakness librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateWeaknessThreatLibraryRequestBody)

Associates weakness to a threat in a risk pattern.

Associates weakness to a threat in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
String threatRef = "threatRef_example"; // String | Reference for Threat
AssociateWeaknessThreatLibraryRequestBody associateWeaknessThreatLibraryRequestBody = new AssociateWeaknessThreatLibraryRequestBody(); // AssociateWeaknessThreatLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryWeakness result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, associateWeaknessThreatLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
threatRef String Reference for Threat
associateWeaknessThreatLibraryRequestBody AssociateWeaknessThreatLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryWeakness

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut

LibraryControl librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, weaknessRef, associateCountermeasureWeaknessLibraryRequestBody)

Associates a countermeasure to a weakness in a risk pattern.

Associates a countermeasure to a weakness in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
String useCaseRef = "useCaseRef_example"; // String | Reference for Use Case
String threatRef = "threatRef_example"; // String | Reference for Threat
String weaknessRef = "weaknessRef_example"; // String | Reference for Weakness
AssociateCountermeasureWeaknessLibraryRequestBody associateCountermeasureWeaknessLibraryRequestBody = new AssociateCountermeasureWeaknessLibraryRequestBody(); // AssociateCountermeasureWeaknessLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryControl result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut(apiToken, libraryRef, riskPatternRef, useCaseRef, threatRef, weaknessRef, associateCountermeasureWeaknessLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefUsecasesUseCaseRefThreatsThreatRefWeaknessesWeaknessRefCountermeasuresPut");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
useCaseRef String Reference for Use Case
threatRef String Reference for Threat
weaknessRef String Reference for Weakness
associateCountermeasureWeaknessLibraryRequestBody AssociateCountermeasureWeaknessLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryControl

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost

LibraryWeakness librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost(apiToken, libraryRef, riskPatternRef, createWeaknessLibraryRequestBody)

Creates a new weakness in a risk pattern

Creates a new Weakness in a risk pattern. Conditions to be able to perform the action: - To have the permission LIBRARY_UPDATE granted.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.RiskPatternsApi;


RiskPatternsApi apiInstance = new RiskPatternsApi();
String apiToken = "apiToken_example"; // String | Authentication token
String libraryRef = "libraryRef_example"; // String | Reference for library
String riskPatternRef = "riskPatternRef_example"; // String | Reference for Risk Pattern
CreateWeaknessLibraryRequestBody createWeaknessLibraryRequestBody = new CreateWeaknessLibraryRequestBody(); // CreateWeaknessLibraryRequestBody | JSON data that contains information of the fields
try {
    LibraryWeakness result = apiInstance.librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost(apiToken, libraryRef, riskPatternRef, createWeaknessLibraryRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RiskPatternsApi#librariesLibraryRefRiskpatternsRiskPatternRefWeaknessesPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiToken String Authentication token
libraryRef String Reference for library
riskPatternRef String Reference for Risk Pattern
createWeaknessLibraryRequestBody CreateWeaknessLibraryRequestBody JSON data that contains information of the fields

Return type

LibraryWeakness

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json
Clone this wiki locally