Class: Falcon::IdentityProtectionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityProtectionApi

Returns a new instance of IdentityProtectionApi.



36
37
38
 
# File 'lib/crimson-falcon/api/identity_protection_api.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_protection_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#api_preempt_proxy_post_graphql(authorization, opts = {}) ⇒ nil

Identity Protection GraphQL API. Allows to retrieve entities, timeline activities, identity-based incidents and security assessment. Allows to perform actions on entities and identity-based incidents.

Parameters:

  • authorization (String) —

    Authorization Header

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

    the optional parameters

Returns:

  • (nil) 


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

def api_preempt_proxy_post_graphql(authorization, opts = {})
  api_preempt_proxy_post_graphql_with_http_info(authorization, opts)
  nil
end

#api_preempt_proxy_post_graphql_with_http_info(authorization, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Identity Protection GraphQL API. Allows to retrieve entities, timeline activities, identity-based incidents and security assessment. Allows to perform actions on entities and identity-based incidents.

Parameters:

  • authorization (String) —

    Authorization Header

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/crimson-falcon/api/identity_protection_api.rb', line 52

def api_preempt_proxy_post_graphql_with_http_info(authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityProtectionApi.api_preempt_proxy_post_graphql ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling IdentityProtectionApi.api_preempt_proxy_post_graphql"
  end
  # resource path
  local_var_path = '/identity-protection/combined/graphql/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', 'application/json; charset=utf-8'])
  header_params[:'Authorization'] = authorization

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IdentityProtectionApi.api_preempt_proxy_post_graphql",
    :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: IdentityProtectionApi#api_preempt_proxy_post_graphql\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end