Class: OpenapiClient::PolicyDecisionPointsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PolicyDecisionPointsApi

Returns a new instance of PolicyDecisionPointsApi.



19
20
21
 
# File 'lib/openapi_client/api/policy_decision_points_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/policy_decision_points_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_authenticating_pdp_config_values(pdp_state_update, opts = {}) ⇒ RemoteConfig

Get connected PDP configuration and push state Gets the configuration values for the currently authenticated PDP container. The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly. The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 27

def get_authenticating_pdp_config_values(pdp_state_update, opts = {})
  data, _status_code, _headers = get_authenticating_pdp_config_values_with_http_info(pdp_state_update, opts)
  data
end

#get_authenticating_pdp_config_values_legacy(opts = {}) ⇒ RemoteConfig

Get connected PDP configuration Gets the configuration values for the currently authenticated PDP container. The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly. The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 94

def get_authenticating_pdp_config_values_legacy(opts = {})
  data, _status_code, _headers = get_authenticating_pdp_config_values_legacy_with_http_info(opts)
  data
end

#get_authenticating_pdp_config_values_legacy_with_http_info(opts = {}) ⇒ Array<(RemoteConfig, Integer, Hash)>

Get connected PDP configuration Gets the configuration values for the currently authenticated PDP container. The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly. The config values returned are considered &quot;overrides&quot;, meaning they are overriding any default values given to the container by the user.

Parameters:

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

    the optional parameters

Returns:

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

    RemoteConfig data, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 103

def get_authenticating_pdp_config_values_legacy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyDecisionPointsApi.get_authenticating_pdp_config_values_legacy ...'
  end
  # resource path
  local_var_path = '/v2/pdps/me/config'

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

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

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

#get_authenticating_pdp_config_values_with_http_info(pdp_state_update, opts = {}) ⇒ Array<(RemoteConfig, Integer, Hash)>

Get connected PDP configuration and push state Gets the configuration values for the currently authenticated PDP container. The PDP authenticates with an API key scoped to a given Permit.io environment. The system identifies the PDP via its API key and then returns all the configuration values required for the container to run correctly. The config values returned are considered &quot;overrides&quot;, meaning they are overriding any default values given to the container by the user.

Parameters:

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

    the optional parameters

Returns:

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

    RemoteConfig data, response status code and response headers



37
38
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
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 37

def get_authenticating_pdp_config_values_with_http_info(pdp_state_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyDecisionPointsApi.get_authenticating_pdp_config_values ...'
  end
  # verify the required parameter 'pdp_state_update' is set
  if @api_client.config.client_side_validation && pdp_state_update.nil?
    fail ArgumentError, "Missing the required parameter 'pdp_state_update' when calling PolicyDecisionPointsApi.get_authenticating_pdp_config_values"
  end
  # resource path
  local_var_path = '/v2/pdps/me/config'

  # 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(pdp_state_update)

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

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

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

#get_pdp_config_values(proj_id, env_id, pdp_id, opts = {}) ⇒ RemoteConfig

Get PDP configuration Gets the configuration values for the PDP container with id ‘pdp_id`. The config values returned are considered "overrides", meaning they are overriding any default values given to the container by the user.

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;).

  • pdp_id (String) —

    The unique id of the pdp

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 154

def get_pdp_config_values(proj_id, env_id, pdp_id, opts = {})
  data, _status_code, _headers = get_pdp_config_values_with_http_info(proj_id, env_id, pdp_id, opts)
  data
end

#get_pdp_config_values_with_http_info(proj_id, env_id, pdp_id, opts = {}) ⇒ Array<(RemoteConfig, Integer, Hash)>

Get PDP configuration Gets the configuration values for the PDP container with id &#x60;pdp_id&#x60;. The config values returned are considered &quot;overrides&quot;, meaning they are overriding any default values given to the container by the user.

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;).

  • pdp_id (String) —

    The unique id of the pdp

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

    the optional parameters

Returns:

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

    RemoteConfig data, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 166

def get_pdp_config_values_with_http_info(proj_id, env_id, pdp_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyDecisionPointsApi.get_pdp_config_values ...'
  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 PolicyDecisionPointsApi.get_pdp_config_values"
  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 PolicyDecisionPointsApi.get_pdp_config_values"
  end
  # verify the required parameter 'pdp_id' is set
  if @api_client.config.client_side_validation && pdp_id.nil?
    fail ArgumentError, "Missing the required parameter 'pdp_id' when calling PolicyDecisionPointsApi.get_pdp_config_values"
  end
  # resource path
  local_var_path = '/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/values'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'pdp_id' + '}', CGI.escape(pdp_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] || 'RemoteConfig'

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

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

#list_pdp_configs(proj_id, env_id, opts = {}) ⇒ Array<PDPConfigRead>

List PDP configurations

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):

  • :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:



229
230
231
232
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 229

def list_pdp_configs(proj_id, env_id, opts = {})
  data, _status_code, _headers = list_pdp_configs_with_http_info(proj_id, env_id, opts)
  data
end

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

List PDP configurations

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):

  • :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<(Array<PDPConfigRead>, Integer, Hash)>) —

    Array<PDPConfigRead> data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 241

def list_pdp_configs_with_http_info(proj_id, env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyDecisionPointsApi.list_pdp_configs ...'
  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 PolicyDecisionPointsApi.list_pdp_configs"
  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 PolicyDecisionPointsApi.list_pdp_configs"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PolicyDecisionPointsApi.list_pdp_configs, 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 PolicyDecisionPointsApi.list_pdp_configs, 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 PolicyDecisionPointsApi.list_pdp_configs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/pdps/{proj_id}/{env_id}/configs'.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[:'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] || 'Array<PDPConfigRead>'

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

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

#rotate_pdp_api_key(proj_id, env_id, pdp_id, opts = {}) ⇒ PDPConfigRead

Rotate PDP API Key Rotates the API key of the PDP container with id ‘pdp_id`. The rotation of the API key revokes the old API key and issues a new API key to the PDP.

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;).

  • pdp_id (String) —

    The unique id of the pdp

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

    the optional parameters

Returns:



314
315
316
317
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 314

def rotate_pdp_api_key(proj_id, env_id, pdp_id, opts = {})
  data, _status_code, _headers = rotate_pdp_api_key_with_http_info(proj_id, env_id, pdp_id, opts)
  data
end

#rotate_pdp_api_key_with_http_info(proj_id, env_id, pdp_id, opts = {}) ⇒ Array<(PDPConfigRead, Integer, Hash)>

Rotate PDP API Key Rotates the API key of the PDP container with id &#x60;pdp_id&#x60;. The rotation of the API key revokes the old API key and issues a new API key to the PDP.

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;).

  • pdp_id (String) —

    The unique id of the pdp

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

    the optional parameters

Returns:

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

    PDPConfigRead data, response status code and response headers



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/openapi_client/api/policy_decision_points_api.rb', line 326

def rotate_pdp_api_key_with_http_info(proj_id, env_id, pdp_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PolicyDecisionPointsApi.rotate_pdp_api_key ...'
  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 PolicyDecisionPointsApi.rotate_pdp_api_key"
  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 PolicyDecisionPointsApi.rotate_pdp_api_key"
  end
  # verify the required parameter 'pdp_id' is set
  if @api_client.config.client_side_validation && pdp_id.nil?
    fail ArgumentError, "Missing the required parameter 'pdp_id' when calling PolicyDecisionPointsApi.rotate_pdp_api_key"
  end
  # resource path
  local_var_path = '/v2/pdps/{proj_id}/{env_id}/configs/{pdp_id}/rotate-api-key'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'pdp_id' + '}', CGI.escape(pdp_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] || 'PDPConfigRead'

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

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