Class: Falcon::IdentityEntities

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/identity_entities.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityEntities

Returns a new instance of IdentityEntities.



36
37
38
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#get_sensor_aggregates(body, opts = {}) ⇒ MsaAggregatesResponse

Get sensor aggregates as specified via json in request body.

Parameters:

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 43

def get_sensor_aggregates(body, opts = {})
  data, _status_code, _headers = get_sensor_aggregates_with_http_info(body, opts)
  data
end

#get_sensor_aggregates_with_http_info(body, opts = {}) ⇒ Array<(MsaAggregatesResponse, Integer, Hash)>

Get sensor aggregates as specified via json in request body.

Parameters:

Returns:

  • (Array<(MsaAggregatesResponse, Integer, Hash)>) —

    MsaAggregatesResponse data, response status code and response headers



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 52

def get_sensor_aggregates_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityEntities.get_sensor_aggregates ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IdentityEntities.get_sensor_aggregates"
  end
  # resource path
  local_var_path = '/identity-protection/aggregates/devices/GET/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'MsaAggregatesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"IdentityEntities.get_sensor_aggregates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityEntities#get_sensor_aggregates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_details(body, opts = {}) ⇒ ApiSensorDetailsResponseSwagger

Get details on one or more sensors by providing device IDs in a POST body. Supports up to a maximum of 5000 IDs.

Parameters:

  • body (MsaIdsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



109
110
111
112
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 109

def get_sensor_details(body, opts = {})
  data, _status_code, _headers = get_sensor_details_with_http_info(body, opts)
  data
end

#get_sensor_details_with_http_info(body, opts = {}) ⇒ Array<(ApiSensorDetailsResponseSwagger, Integer, Hash)>

Get details on one or more sensors by providing device IDs in a POST body. Supports up to a maximum of 5000 IDs.

Parameters:

  • body (MsaIdsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 118

def get_sensor_details_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityEntities.get_sensor_details ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IdentityEntities.get_sensor_details"
  end
  # resource path
  local_var_path = '/identity-protection/entities/devices/GET/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ApiSensorDetailsResponseSwagger'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"IdentityEntities.get_sensor_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityEntities#get_sensor_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_sensors_by_filter(opts = {}) ⇒ MsaspecQueryResponse

Search for sensors in your environment by hostname, IP, and other criteria.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-200]

  • :sort (String) —

    The property to sort by (e.g. status.desc or hostname.asc)

  • :filter (String) —

    The filter expression that should be used to limit the results

Returns:



178
179
180
181
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 178

def query_sensors_by_filter(opts = {})
  data, _status_code, _headers = query_sensors_by_filter_with_http_info(opts)
  data
end

#query_sensors_by_filter_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Search for sensors in your environment by hostname, IP, and other criteria.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from

  • :limit (Integer) —

    The maximum records to return. [1-200]

  • :sort (String) —

    The property to sort by (e.g. status.desc or hostname.asc)

  • :filter (String) —

    The filter expression that should be used to limit the results

Returns:

  • (Array<(MsaspecQueryResponse, Integer, Hash)>) —

    MsaspecQueryResponse data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/crimson-falcon/api/identity_entities.rb', line 190

def query_sensors_by_filter_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityEntities.query_sensors_by_filter ...'
  end
  # resource path
  local_var_path = '/identity-protection/queries/devices/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"IdentityEntities.query_sensors_by_filter",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityEntities#query_sensors_by_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end