ESP::SignaturesApi

All URIs are relative to https://api.evident.io

Method	HTTP request	Description
list	PUT /api/v2/signatures.json_api	Get a list of Signatures
list_disabled_external_accounts	GET /api/v2/signatures/{signature_id}/disabled_external_accounts.json_api	Get a list of disabled External Accounts for a signature
list_with_custom_risk_level_for_external_account	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
remove_custom_risk_level_for_external_account	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
set_custom_risk_level_for_external_account	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
update_custom_risk_level_for_external_account	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(opts)

Get a list of Signatures

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
  filter: {'key' => "filter_example"}, # Hash<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.
  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.
}

begin
  #Get a list of Signatures
  result = api_instance.list(opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->list: #{e}"
end

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	Hash<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

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

list_disabled_external_accounts

PaginatedCollection list_disabled_external_accounts(signature_id, opts)

Get a list of disabled External Accounts for a signature

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

signature_id = 56 # Integer | The ID of the signature to get the list of disabled external accounts for

opts = { 
  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.
  filter: {'key' => "filter_example"}, # Hash<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.
  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.
}

begin
  #Get a list of disabled External Accounts for a signature
  result = api_instance.list_disabled_external_accounts(signature_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->list_disabled_external_accounts: #{e}"
end

Parameters

Name	Type	Description	Notes
signature_id	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	Hash<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

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

list_with_custom_risk_level_for_external_account

PaginatedCollection list_with_custom_risk_level_for_external_account(external_account_id, opts)

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

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

external_account_id = 56 # Integer | The ID of the external account to retrieve

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
  filter: {'key' => "filter_example"}, # Hash<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.
  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.
}

begin
  #Get A list of Signatures with default and custom risk levels for an External Account
  result = api_instance.list_with_custom_risk_level_for_external_account(external_account_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->list_with_custom_risk_level_for_external_account: #{e}"
end

Parameters

Name	Type	Description	Notes
external_account_id	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	Hash<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

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

remove_custom_risk_level_for_external_account

Meta remove_custom_risk_level_for_external_account(external_account_id, signature_id)

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

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

external_account_id = 56 # Integer | The ID of the external account this signature custom risk level is for

signature_id = 56 # Integer | The signature ID this signature custom risk level is for


begin
  #Remove a custom risk level to a Signature for an External Account
  result = api_instance.remove_custom_risk_level_for_external_account(external_account_id, signature_id)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->remove_custom_risk_level_for_external_account: #{e}"
end

Parameters

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

Return type

Meta

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

set_custom_risk_level_for_external_account

Signature set_custom_risk_level_for_external_account(external_account_id, risk_level, signature_id, opts)

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

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

external_account_id = 56 # Integer | The ID of the external account this signature custom risk level is for

risk_level = "risk_level_example" # String | The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high

signature_id = 56 # Integer | The signature ID this signature custom risk level is for

opts = { 
  include: "include_example" # String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
}

begin
  #Add a custom risk level to a Signature for an External Account
  result = api_instance.set_custom_risk_level_for_external_account(external_account_id, risk_level, signature_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->set_custom_risk_level_for_external_account: #{e}"
end

Parameters

Name	Type	Description	Notes
external_account_id	Integer	The ID of the external account this signature custom risk level is for
risk_level	String	The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high
signature_id	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

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

show

Signature show(id, opts)

Show a single Signature

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

id = 56 # Integer | Signature ID

opts = { 
  include: "include_example" # String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
}

begin
  #Show a single Signature
  result = api_instance.show(id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->show: #{e}"
end

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

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

update_custom_risk_level_for_external_account

Signature update_custom_risk_level_for_external_account(external_account_id, signature_id, opts)

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

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::SignaturesApi.new

external_account_id = 56 # Integer | The ID of the external account this signature custom risk level is for

signature_id = 56 # Integer | The signature ID this signature custom risk level is for

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
  risk_level: "risk_level_example" # String | The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high
}

begin
  #Update a Signature's custom risk level for an External Account
  result = api_instance.update_custom_risk_level_for_external_account(external_account_id, signature_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling SignaturesApi->update_custom_risk_level_for_external_account: #{e}"
end

Parameters

Name	Type	Description	Notes
external_account_id	Integer	The ID of the external account this signature custom risk level is for
signature_id	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]
risk_level	String	The custom risk-level of the problem identified by the signature for this external_account. Valid values are low, medium, high	[optional]

Return type

Signature

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

FilesExpand file tree

SignaturesApi.md

Latest commit

History

SignaturesApi.md

File metadata and controls

ESP::SignaturesApi

list

Example

Parameters

Return type

Authorization

HTTP request headers

list_disabled_external_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

list_with_custom_risk_level_for_external_account

Example

Parameters

Return type

Authorization

HTTP request headers

remove_custom_risk_level_for_external_account

Example

Parameters

Return type

Authorization

HTTP request headers

set_custom_risk_level_for_external_account

Example

Parameters

Return type

Authorization

HTTP request headers

show

Example

Parameters

Return type

Authorization

HTTP request headers

update_custom_risk_level_for_external_account

Example

Parameters

Return type

Authorization

HTTP request headers