Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

SignaturesApi.md

Latest commit

 

History

History
362 lines (254 loc) · 19 KB

SignaturesApi.md

File metadata and controls

362 lines (254 loc) · 19 KB

SignaturesApi

All URIs are relative to http://localhost/

Method HTTP request Description
list PUT api/v2/signatures.json_api Get a list of Signatures
listDisabledExternalAccounts GET api/v2/signatures/{signature_id}/disabled_external_accounts.json_api Get a list of disabled External Accounts for a signature
listWithCustomRiskLevelForExternalAccount PUT api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels.json_api Get A list of Signatures with default and custom risk levels for an External Account
removeCustomRiskLevelForExternalAccount DELETE api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels/{signature_id}.json_api Remove a custom risk level to a Signature for an External Account
setCustomRiskLevelForExternalAccount POST api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels.json_api Add a custom risk level to a Signature for an External Account
show GET api/v2/signatures/{id}.json_api Show a single Signature
updateCustomRiskLevelForExternalAccount PATCH api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels/{signature_id}.json_api Update a Signature's custom risk level for an External Account

list

PaginatedCollection list(include, filter, page)

Get a list of Signatures

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#list");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

listDisabledExternalAccounts

PaginatedCollection listDisabledExternalAccounts(signatureId, include, filter, page)

Get a list of disabled External Accounts for a signature

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer signatureId = 56; // Integer | The ID of the signature to get the list of disabled external accounts for
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, nickname, name] Matching Searchable Attributes: [nickname, name] Limited Searchable Attributes: [account_eq, arn_eq, provider_eq, subscription_id_eq] Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, team, azure_group, compliance_standards, disabled_signatures, integrations, scheduled_exports, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.listDisabledExternalAccounts(signatureId, include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#listDisabledExternalAccounts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
signatureId Integer The ID of the signature to get the list of disabled external accounts for
include String Related objects that can be included in the response: organization, sub_organization, team, scan_intervals, disabled_signatures, suppressions, azure_group See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, nickname, name] Matching Searchable Attributes: [nickname, name] Limited Searchable Attributes: [account_eq, arn_eq, provider_eq, subscription_id_eq] Sortable Attributes: [name, updated_at, created_at, id] Searchable Associations: [organization, sub_organization, team, azure_group, compliance_standards, disabled_signatures, integrations, scheduled_exports, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

listWithCustomRiskLevelForExternalAccount

PaginatedCollection listWithCustomRiskLevelForExternalAccount(externalAccountId, include, filter, page)

Get A list of Signatures with default and custom risk levels for an External Account

Return only signatures that have a custom risk level set by searching with `filter:{custom_risk_level_present: 1}`

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to retrieve
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [custom_risk_level_present, service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.listWithCustomRiskLevelForExternalAccount(externalAccountId, include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#listWithCustomRiskLevelForExternalAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to retrieve
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, risk_level, service_id, disabled, supports_user_attribution, name, identifier, description, resolution] Matching Searchable Attributes: [name, identifier, description, resolution] Limited Searchable Attributes: [custom_risk_level_present, service_provider_eq, service_provider_in, service_name_in] Sortable Attributes: [name, identifier, updated_at, created_at, id] Searchable Associations: [signature_copy, disabled_external_accounts, integrations, suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

removeCustomRiskLevelForExternalAccount

Meta removeCustomRiskLevelForExternalAccount(externalAccountId, signatureId)

Remove a custom risk level to a Signature for an External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this signature custom risk level is for
Integer signatureId = 56; // Integer | The signature ID this signature custom risk level is for
try {
    Meta result = apiInstance.removeCustomRiskLevelForExternalAccount(externalAccountId, signatureId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#removeCustomRiskLevelForExternalAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this signature custom risk level is for
signatureId Integer The signature ID this signature custom risk level is for

Return type

Meta

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

setCustomRiskLevelForExternalAccount

Signature setCustomRiskLevelForExternalAccount(externalAccountId, riskLevel, signatureId, include)

Add a custom risk level to a Signature for an External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this signature custom risk level is for
String riskLevel = "riskLevel_example"; // String | The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high
Integer signatureId = 56; // Integer | The signature ID this signature custom risk level is for
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
try {
    Signature result = apiInstance.setCustomRiskLevelForExternalAccount(externalAccountId, riskLevel, signatureId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#setCustomRiskLevelForExternalAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this signature custom risk level is for
riskLevel String The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high [enum: low, medium, high]
signatureId Integer The signature ID this signature custom risk level is for
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]

Return type

Signature

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

Signature show(id, include)

Show a single Signature

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer id = 56; // Integer | Signature ID
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
try {
    Signature result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Signature ID
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]

Return type

Signature

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

updateCustomRiskLevelForExternalAccount

Signature updateCustomRiskLevelForExternalAccount(externalAccountId, signatureId, include, riskLevel)

Update a Signature's custom risk level for an External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.SignaturesApi;


SignaturesApi apiInstance = new SignaturesApi();
Integer externalAccountId = 56; // Integer | The ID of the external account this signature custom risk level is for
Integer signatureId = 56; // Integer | The signature ID this signature custom risk level is for
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
String riskLevel = "riskLevel_example"; // String | The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high
try {
    Signature result = apiInstance.updateCustomRiskLevelForExternalAccount(externalAccountId, signatureId, include, riskLevel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SignaturesApi#updateCustomRiskLevelForExternalAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account this signature custom risk level is for
signatureId Integer The signature ID this signature custom risk level is for
include String Related objects that can be included in the response: service, suppressions See Including Objects for more information. [optional]
riskLevel String The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high [optional] [enum: low, medium, high]

Return type

Signature

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json