module Resource::Policies

Namespace for Policies resource.

Public Instance Methods

get_policy_by_name(policy_name) click to toggle source

Get a policy by its name. @param [String] policy name. @return [JSON] policy object.

# File lib/modules/policies.rb, line 23
def get_policy_by_name(policy_name)
  policy_id = get_policy_id_by_name(policy_name)
  request.get({ path: "/policies/#{policy_id}", headers: headers })
end
get_policy_id_by_name(policy_name) click to toggle source

Get id of a policy by its name. @param [String] policy name. @return [Integer] ID of a policy.

# File lib/modules/policies.rb, line 14
def get_policy_id_by_name(policy_name)
  policies['policies'].each do |policy|
    return policy['id'] if policy['name'] == policy_name
  end
end
list_credentials_by_policy_name(policy_name) click to toggle source

Get a list of credentials from a policy. @param [String] policy name. @return [JSON] credential list

# File lib/modules/policies.rb, line 31
def list_credentials_by_policy_name(policy_name)
  get_policy_by_name(policy_name)['credentials']
end
policies() click to toggle source

List the scan polices. @return [JSON] list of policies.

# File lib/modules/policies.rb, line 7
def policies
  request.get({ path: '/policies', headers: headers })
end
update_policy_by_name(policy_name, payload) click to toggle source

update a scan policy. @param [String] policy name. @param [String] history_id (nil) The `history_id` of a scan. @return nil

# File lib/modules/policies.rb, line 39
def update_policy_by_name(policy_name, payload)
  id = get_policy_id_by_name(policy_name)
  request.put({ path: "/policies/#{id}", headers: headers, payload: payload })
end