Class: OpenapiClient::AuthenticationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthenticationApi

Returns a new instance of AuthenticationApi.



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

def api_client
  @api_client
end

Instance Method Details

#dev_login(dev_login, opts = {}) ⇒ nil

(DEV MODE) Login The dev-login endpoints allows a developer inside permit.io to log in with an email address. THIS IS ONLY AVAILABLE IN DEV MODE.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def (, opts = {})
  (, opts)
  nil
end

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

(DEV MODE) Login The dev-login endpoints allows a developer inside permit.io to log in with an email address. THIS IS ONLY AVAILABLE IN DEV MODE.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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/authentication_api.rb', line 37

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#elements_login_as(user_login_request_input, opts = {}) ⇒ EmbeddedLoginRequestOutput

Elements Login As

Parameters:

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

    the optional parameters

Returns:



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

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

#elements_login_as_with_http_info(user_login_request_input, opts = {}) ⇒ Array<(EmbeddedLoginRequestOutput, Integer, Hash)>

Elements Login As

Parameters:

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

    the optional parameters

Returns:

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

    EmbeddedLoginRequestOutput 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
146
147
148
149
150
151
152
153
154
 
# File 'lib/openapi_client/api/authentication_api.rb', line 103

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

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

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

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

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

#login(opts = {}) ⇒ LoginResult

Login The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invite_code (String) —

    An optional invite code to an existing organization. If the invite code is provided and is valid, the member will gain access to that organization.

Returns:



161
162
163
164
 
# File 'lib/openapi_client/api/authentication_api.rb', line 161

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

#login_elements(token, opts = {}) ⇒ LoginResult

Login Elements The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

Parameters:

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/openapi_client/api/authentication_api.rb', line 221

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

#login_elements_with_http_info(token, opts = {}) ⇒ Array<(LoginResult, Integer, Hash)>

Login Elements The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

Parameters:

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

    the optional parameters

Returns:

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

    LoginResult data, response status code and response headers



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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/openapi_client/api/authentication_api.rb', line 231

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

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

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

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

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

#login_with_http_info(opts = {}) ⇒ Array<(LoginResult, Integer, Hash)>

Login The login endpoint allows the frontend app to exchange a user JWT with a user session. The user session is stored on an httpOnly + secure cookie.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invite_code (String) —

    An optional invite code to an existing organization. If the invite code is provided and is valid, the member will gain access to that organization.

Returns:

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

    LoginResult data, response status code and response headers



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
 
# File 'lib/openapi_client/api/authentication_api.rb', line 171

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.login ...'
  end
  # resource path
  local_var_path = '/v2/auth/login'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'invite_code'] = opts[:'invite_code'] if !opts[:'invite_code'].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] || 'LoginResult'

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

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

#logout_get(opts = {}) ⇒ nil

Logout Get The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


284
285
286
287
 
# File 'lib/openapi_client/api/authentication_api.rb', line 284

def logout_get(opts = {})
  logout_get_with_http_info(opts)
  nil
end

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

Logout Get The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/openapi_client/api/authentication_api.rb', line 293

def logout_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.logout_get ...'
  end
  # resource path
  local_var_path = '/v2/auth/logout'

  # 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 => :"AuthenticationApi.logout_get",
    :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: AuthenticationApi#logout_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#logout_post(opts = {}) ⇒ nil

Logout Post The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


341
342
343
344
 
# File 'lib/openapi_client/api/authentication_api.rb', line 341

def logout_post(opts = {})
  logout_post_with_http_info(opts)
  nil
end

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

Logout Post The logout endpoint deletes the session cookie of a logged in user and invalidates cached VCs.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/openapi_client/api/authentication_api.rb', line 350

def logout_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.logout_post ...'
  end
  # resource path
  local_var_path = '/v2/auth/logout'

  # 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 => :"AuthenticationApi.logout_post",
    :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: AuthenticationApi#logout_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#me(opts = {}) ⇒ AuthnMeRead

Me

Parameters:

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

    the optional parameters

Returns:



397
398
399
400
 
# File 'lib/openapi_client/api/authentication_api.rb', line 397

def me(opts = {})
  data, _status_code, _headers = me_with_http_info(opts)
  data
end

#me_with_http_info(opts = {}) ⇒ Array<(AuthnMeRead, Integer, Hash)>

Me

Parameters:

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

    the optional parameters

Returns:

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

    AuthnMeRead data, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/openapi_client/api/authentication_api.rb', line 405

def me_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.me ...'
  end
  # resource path
  local_var_path = '/v2/auth/me'

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

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

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

#switch_organization(org_id, opts = {}) ⇒ LoginResult

Switch Organization Allows the user to switch his active organization (manipulates the user’s login session). This route will return a new login cookie to the user.

Parameters:

  • org_id (String) —

    the organization id the user wishes to switch to as the active org on the session

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

    the optional parameters

Returns:



454
455
456
457
 
# File 'lib/openapi_client/api/authentication_api.rb', line 454

def switch_organization(org_id, opts = {})
  data, _status_code, _headers = switch_organization_with_http_info(org_id, opts)
  data
end

#switch_organization_with_http_info(org_id, opts = {}) ⇒ Array<(LoginResult, Integer, Hash)>

Switch Organization Allows the user to switch his active organization (manipulates the user&#39;s login session). This route will return a new login cookie to the user.

Parameters:

  • org_id (String) —

    the organization id the user wishes to switch to as the active org on the session

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

    the optional parameters

Returns:

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

    LoginResult data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/openapi_client/api/authentication_api.rb', line 464

def switch_organization_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.switch_organization ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling AuthenticationApi.switch_organization"
  end
  # resource path
  local_var_path = '/v2/auth/switch_org/{org_id}'.sub('{' + 'org_id' + '}', CGI.escape(org_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] || 'LoginResult'

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

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