Class: OpenapiClient::AuditLogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/audit_logs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuditLogsApi

Returns a new instance of AuditLogsApi.



19
20
21
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_detailed_audit_log(proj_id, env_id, log_id, opts = {}) ⇒ DetailedAuditLog

Get detailed audit log

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

  • log_id (String) —

    The unique id of the audit log

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 28

def get_detailed_audit_log(proj_id, env_id, log_id, opts = {})
  data, _status_code, _headers = get_detailed_audit_log_with_http_info(proj_id, env_id, log_id, opts)
  data
end

#get_detailed_audit_log_with_http_info(proj_id, env_id, log_id, opts = {}) ⇒ Array<(DetailedAuditLog, Integer, Hash)>

Get detailed audit log

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

  • log_id (String) —

    The unique id of the audit log

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

    the optional parameters

Returns:

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

    DetailedAuditLog data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
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
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 39

def get_detailed_audit_log_with_http_info(proj_id, env_id, log_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogsApi.get_detailed_audit_log ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling AuditLogsApi.get_detailed_audit_log"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling AuditLogsApi.get_detailed_audit_log"
  end
  # verify the required parameter 'log_id' is set
  if @api_client.config.client_side_validation && log_id.nil?
    fail ArgumentError, "Missing the required parameter 'log_id' when calling AuditLogsApi.get_detailed_audit_log"
  end
  # resource path
  local_var_path = '/v2/pdps/{proj_id}/{env_id}/audit_logs/{log_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'log_id' + '}', CGI.escape(log_id.to_s))

  # 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'])

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

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

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

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

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

#list_audit_logs(proj_id, env_id, opts = {}) ⇒ PaginatedResultAuditLog

List Audit Logs

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :pdp_id (String) —

    Filter by pdp config id

  • :users (Array<String>) —

    List of user keys or emails to filter by

  • :decision (Boolean) —

    Filter by decision result

  • :resources (Array<String>) —

    Filter by resources

  • :tenant (String) —

    Filter by tenant

  • :action (String) —

    Filter by action

  • :timestamp_from (Integer) —

    Filter by timestamp from

  • :timestamp_to (Integer) —

    Filter by timestamp to

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



110
111
112
113
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 110

def list_audit_logs(proj_id, env_id, opts = {})
  data, _status_code, _headers = list_audit_logs_with_http_info(proj_id, env_id, opts)
  data
end

#list_audit_logs_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(PaginatedResultAuditLog, Integer, Hash)>

List Audit Logs

Parameters:

  • proj_id (String) —

    Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).

  • env_id (String) —

    Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).

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

    the optional parameters

Options Hash (opts):

  • :pdp_id (String) —

    Filter by pdp config id

  • :users (Array<String>) —

    List of user keys or emails to filter by

  • :decision (Boolean) —

    Filter by decision result

  • :resources (Array<String>) —

    Filter by resources

  • :tenant (String) —

    Filter by tenant

  • :action (String) —

    Filter by action

  • :timestamp_from (Integer) —

    Filter by timestamp from

  • :timestamp_to (Integer) —

    Filter by timestamp to

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

    PaginatedResultAuditLog data, response status code and response headers



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/openapi_client/api/audit_logs_api.rb', line 130

def list_audit_logs_with_http_info(proj_id, env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuditLogsApi.list_audit_logs ...'
  end
  # verify the required parameter 'proj_id' is set
  if @api_client.config.client_side_validation && proj_id.nil?
    fail ArgumentError, "Missing the required parameter 'proj_id' when calling AuditLogsApi.list_audit_logs"
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling AuditLogsApi.list_audit_logs"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AuditLogsApi.list_audit_logs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AuditLogsApi.list_audit_logs, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AuditLogsApi.list_audit_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/pdps/{proj_id}/{env_id}/audit_logs'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pdp_id'] = opts[:'pdp_id'] if !opts[:'pdp_id'].nil?
  query_params[:'users'] = @api_client.build_collection_param(opts[:'users'], :multi) if !opts[:'users'].nil?
  query_params[:'decision'] = opts[:'decision'] if !opts[:'decision'].nil?
  query_params[:'resources'] = @api_client.build_collection_param(opts[:'resources'], :multi) if !opts[:'resources'].nil?
  query_params[:'tenant'] = opts[:'tenant'] if !opts[:'tenant'].nil?
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'timestamp_from'] = opts[:'timestamp_from'] if !opts[:'timestamp_from'].nil?
  query_params[:'timestamp_to'] = opts[:'timestamp_to'] if !opts[:'timestamp_to'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'PaginatedResultAuditLog'

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

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