Class: OryOathkeeperClient::ApiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-oathkeeper-client/api/api_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiApi

Returns a new instance of ApiApi.



19
20
21
 
# File 'lib/ory-oathkeeper-client/api/api_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/ory-oathkeeper-client/api/api_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#decisions(opts = {}) ⇒ nil

Access Control Decision API > This endpoint works with all HTTP Methods (GET, POST, PUT, …) and matches every path prefixed with /decisions. This endpoint mirrors the proxy capability of ORY Oathkeeper’s proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 26

def decisions(opts = {})
  decisions_with_http_info(opts)
  nil
end

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

Access Control Decision API &gt; This endpoint works with all HTTP Methods (GET, POST, PUT, …) and matches every path prefixed with /decisions. This endpoint mirrors the proxy capability of ORY Oathkeeper&#39;s proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
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
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 35

def decisions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiApi.decisions ...'
  end
  # resource path
  local_var_path = '/decisions'

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

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

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

#get_rule(id, opts = {}) ⇒ Rule

Retrieve a Rule Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.

Parameters:

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 84

def get_rule(id, opts = {})
  data, _status_code, _headers = get_rule_with_http_info(id, opts)
  data
end

#get_rule_with_http_info(id, opts = {}) ⇒ Array<(Rule, Integer, Hash)>

Retrieve a Rule Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.

Parameters:

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

    the optional parameters

Returns:

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

    Rule data, response status code and response headers



94
95
96
97
98
99
100
101
102
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
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 94

def get_rule_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiApi.get_rule ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ApiApi.get_rule"
  end
  # resource path
  local_var_path = '/rules/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'Rule'

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

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

#get_well_known_json_web_keys(opts = {}) ⇒ JsonWebKeySet

Lists Cryptographic Keys This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.

Parameters:

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 146

def get_well_known_json_web_keys(opts = {})
  data, _status_code, _headers = get_well_known_json_web_keys_with_http_info(opts)
  data
end

#get_well_known_json_web_keys_with_http_info(opts = {}) ⇒ Array<(JsonWebKeySet, Integer, Hash)>

Lists Cryptographic Keys This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.

Parameters:

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

    the optional parameters

Returns:

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

    JsonWebKeySet data, response status code and response headers



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
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 155

def get_well_known_json_web_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiApi.get_well_known_json_web_keys ...'
  end
  # resource path
  local_var_path = '/.well-known/jwks.json'

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

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

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

#list_rules(opts = {}) ⇒ Array<Rule>

List All Rules This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum amount of rules returned.

  • :offset (Integer) —

    The offset from where to start looking.

Returns:



205
206
207
208
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 205

def list_rules(opts = {})
  data, _status_code, _headers = list_rules_with_http_info(opts)
  data
end

#list_rules_with_http_info(opts = {}) ⇒ Array<(Array<Rule>, Integer, Hash)>

List All Rules This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum amount of rules returned.

  • :offset (Integer) —

    The offset from where to start looking.

Returns:

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

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ory-oathkeeper-client/api/api_api.rb', line 216

def list_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiApi.list_rules ...'
  end
  # resource path
  local_var_path = '/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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<Rule>'

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

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