Module: Controls::Client::PrioritizedGuidance

Included in:
Controls::Client
Defined in:
lib/controls/client/prioritized_guidance.rb

Overview

A module to encapsulate API methods related to guidance

Since:

  • API v1.0

Version:

  • v1.0.0

Prioritized Guidance Methods collapse

Instance Method Details

#prioritized_guidance_by_configuration(configuration) ⇒ Array<Hash>

Returns an array of “guidance hashes”.

Parameters:

  • configuration (String) —

    the configuration name to search by

Returns:

  • (Array<Hash>) —

    an array of “guidance hashes”

Since:

  • API v1.0



17
18
19
 
# File 'lib/controls/client/prioritized_guidance.rb', line 17

def prioritized_guidance_by_configuration(configuration)
  get "/configurations/#{configuration}/prioritized_guidance"
end

#prioritized_guidance_by_security_control(security_control) ⇒ Array<Hash>

Returns an array of “guidance hashes”.

Parameters:

  • security_control (String) —

    the security control name to search by

Returns:

  • (Array<Hash>) —

    an array of “guidance hashes”

Since:

  • API v1.0



11
12
13
 
# File 'lib/controls/client/prioritized_guidance.rb', line 11

def prioritized_guidance_by_security_control(security_control)
  get "/security_controls/#{security_control}/prioritized_guidance"
end

#prioritized_guidance_by_threat(threat) ⇒ Array<Hash>

Returns an array of “guidance hashes”.

Parameters:

  • threat (String) —

    the threat name to search by

Returns:

  • (Array<Hash>) —

    an array of “guidance hashes”

Since:

  • API v1.0



23
24
25
 
# File 'lib/controls/client/prioritized_guidance.rb', line 23

def prioritized_guidance_by_threat(threat)
  get "/threats/#{threat}/prioritized_guidance"
end

#prioritized_guidance_by_threat_vector(threat_vector) ⇒ Array<Hash>

Returns an array of “guidance hashes”.

Parameters:

  • threat_vector (String) —

    the threat name to search by

Returns:

  • (Array<Hash>) —

    an array of “guidance hashes”

Since:

  • API v1.0



29
30
31
 
# File 'lib/controls/client/prioritized_guidance.rb', line 29

def prioritized_guidance_by_threat_vector(threat_vector)
  get "/threat_vectors/#{threat_vector}/prioritized_guidance"
end