Class: FusionAuth::FusionAuthClient

Inherits:
Object
  • Object
show all
Defined in:
lib/fusionauth/fusionauth_client.rb

Overview

This class is the the Ruby client library for the FusionAuth CIAM Platform https://fusionauth.io

Each method on this class calls one of the APIs for FusionAuth. In most cases, the methods will take either a Hash, an OpenStruct or any object that can be safely converted to JSON that conforms to the FusionAuth API interface. Likewise, most methods will return an OpenStruct that contains the response JSON from FusionAuth.

noinspection RubyInstanceMethodNamingConvention,RubyTooManyMethodsInspection,RubyParameterNamingConvention

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key, base_url) ⇒ FusionAuthClient

Returns a new instance of FusionAuthClient.



32
33
34
35
36
37
38
 
# File 'lib/fusionauth/fusionauth_client.rb', line 32

def initialize(api_key, base_url)
  @api_key = api_key
  @base_url = base_url
  @connect_timeout = 1000
  @read_timeout = 2000
  @tenant_id = nil
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



30
31
32
 
# File 'lib/fusionauth/fusionauth_client.rb', line 30

def api_key
  @api_key
end

#base_url ⇒ Object

Returns the value of attribute base_url.



30
31
32
 
# File 'lib/fusionauth/fusionauth_client.rb', line 30

def base_url
  @base_url
end

#connect_timeout ⇒ Object

Returns the value of attribute connect_timeout.



30
31
32
 
# File 'lib/fusionauth/fusionauth_client.rb', line 30

def connect_timeout
  @connect_timeout
end

#read_timeout ⇒ Object

Returns the value of attribute read_timeout.



30
31
32
 
# File 'lib/fusionauth/fusionauth_client.rb', line 30

def read_timeout
  @read_timeout
end

#tenant_id ⇒ Object

Returns the value of attribute tenant_id.



30
31
32
 
# File 'lib/fusionauth/fusionauth_client.rb', line 30

def tenant_id
  @tenant_id
end

Instance Method Details

#action_user(request) ⇒ FusionAuth::ClientResponse

Takes an action on a user. The user being actioned is called the “actionee” and the user taking the action is called the “actioner”. Both user ids are required in the request object.

Parameters:

  • request (OpenStruct, Hash) —

    The action request that includes all of the information about the action being taken including the id of the action, any options and the duration (if applicable).

Returns:



51
52
53
54
55
56
 
# File 'lib/fusionauth/fusionauth_client.rb', line 51

def action_user(request)
  start.uri('/api/user/action')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#add_user_to_family(family_id, request) ⇒ FusionAuth::ClientResponse

Adds a user to an existing family. The family id must be specified.

Parameters:

  • family_id (string) —

    The id of the family.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to determine which user to add to the family.

Returns:



64
65
66
67
68
69
70
 
# File 'lib/fusionauth/fusionauth_client.rb', line 64

def add_user_to_family(family_id, request)
  start.uri('/api/user/family')
      .url_segment(family_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#cancel_action(action_id, request) ⇒ FusionAuth::ClientResponse

Cancels the user action.

Parameters:

  • action_id (string) —

    The action id of the action to cancel.

  • request (OpenStruct, Hash) —

    The action request that contains the information about the cancellation.

Returns:



78
79
80
81
82
83
84
 
# File 'lib/fusionauth/fusionauth_client.rb', line 78

def cancel_action(action_id, request)
  start.uri('/api/user/action')
      .url_segment(action_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .delete()
      .go()
end

#change_password(change_password_id, request) ⇒ FusionAuth::ClientResponse

Changes a user’s password using the change password Id. This usually occurs after an email has been sent to the user and they clicked on a link to reset their password.

Parameters:

  • change_password_id (string) —

    The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.

  • request (OpenStruct, Hash) —

    The change password request that contains all of the information used to change the password.

Returns:



93
94
95
96
97
98
99
 
# File 'lib/fusionauth/fusionauth_client.rb', line 93

def change_password(change_password_id, request)
  start.uri('/api/user/change-password')
      .url_segment(change_password_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#change_password_by_identity(request) ⇒ FusionAuth::ClientResponse

Changes a user’s password using their identity (login id and password). Using a loginId instead of the changePasswordId bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword method.

Parameters:

  • request (OpenStruct, Hash) —

    The change password request that contains all of the information used to change the password.

Returns:



108
109
110
111
112
113
 
# File 'lib/fusionauth/fusionauth_client.rb', line 108

def change_password_by_identity(request)
  start.uri('/api/user/change-password')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#comment_on_user(request) ⇒ FusionAuth::ClientResponse

Adds a comment to the user’s account.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the user comment.

Returns:



120
121
122
123
124
125
 
# File 'lib/fusionauth/fusionauth_client.rb', line 120

def comment_on_user(request)
  start.uri('/api/user/comment')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_application(application_id, request) ⇒ FusionAuth::ClientResponse

Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.

Parameters:

  • application_id (string) —

    (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the application.

Returns:



133
134
135
136
137
138
139
 
# File 'lib/fusionauth/fusionauth_client.rb', line 133

def create_application(application_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse

Creates a new role for an application. You must specify the id of the application you are creating the role for. You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.

Parameters:

  • application_id (string) —

    The Id of the application to create the role on.

  • role_id (string) —

    (Optional) The Id of the role. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the application role.

Returns:



149
150
151
152
153
154
155
156
157
 
# File 'lib/fusionauth/fusionauth_client.rb', line 149

def create_application_role(application_id, role_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("role")
      .url_segment(role_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_audit_log(request) ⇒ FusionAuth::ClientResponse

Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the audit log entry.

Returns:



166
167
168
169
170
171
 
# File 'lib/fusionauth/fusionauth_client.rb', line 166

def create_audit_log(request)
  start.uri('/api/system/audit-log')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_connector(connector_id, request) ⇒ FusionAuth::ClientResponse

Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.

Parameters:

  • connector_id (string) —

    (Optional) The Id for the connector. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the connector.

Returns:



179
180
181
182
183
184
185
 
# File 'lib/fusionauth/fusionauth_client.rb', line 179

def create_connector(connector_id, request)
  start.uri('/api/connector')
      .url_segment(connector_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_consent(consent_id, request) ⇒ FusionAuth::ClientResponse

Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.

Parameters:

  • consent_id (string) —

    (Optional) The Id for the consent. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the consent.

Returns:



193
194
195
196
197
198
199
 
# File 'lib/fusionauth/fusionauth_client.rb', line 193

def create_consent(consent_id, request)
  start.uri('/api/consent')
      .url_segment(consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse

Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.

Parameters:

  • email_template_id (string) —

    (Optional) The Id for the template. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the email template.

Returns:



207
208
209
210
211
212
213
 
# File 'lib/fusionauth/fusionauth_client.rb', line 207

def create_email_template(email_template_id, request)
  start.uri('/api/email/template')
      .url_segment(email_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_family(family_id, request) ⇒ FusionAuth::ClientResponse

Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the family, if not provided one will be generated.

Parameters:

  • family_id (string) —

    (Optional) The id for the family. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the family.

Returns:



222
223
224
225
226
227
228
 
# File 'lib/fusionauth/fusionauth_client.rb', line 222

def create_family(family_id, request)
  start.uri('/api/user/family')
      .url_segment(family_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_form(form_id, request) ⇒ FusionAuth::ClientResponse

Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.

Parameters:

  • form_id (string) —

    (Optional) The Id for the form. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the form.

Returns:



236
237
238
239
240
241
242
 
# File 'lib/fusionauth/fusionauth_client.rb', line 236

def create_form(form_id, request)
  start.uri('/api/form')
      .url_segment(form_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_form_field(field_id, request) ⇒ FusionAuth::ClientResponse

Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.

Parameters:

  • field_id (string) —

    (Optional) The Id for the form field. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the form field.

Returns:



250
251
252
253
254
255
256
 
# File 'lib/fusionauth/fusionauth_client.rb', line 250

def create_form_field(field_id, request)
  start.uri('/api/form/field')
      .url_segment(field_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_group(group_id, request) ⇒ FusionAuth::ClientResponse

Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.

Parameters:

  • group_id (string) —

    (Optional) The Id for the group. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the group.

Returns:



264
265
266
267
268
269
270
 
# File 'lib/fusionauth/fusionauth_client.rb', line 264

def create_group(group_id, request)
  start.uri('/api/group')
      .url_segment(group_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_group_members(request) ⇒ FusionAuth::ClientResponse

Creates a member in a group.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the group member(s).

Returns:



277
278
279
280
281
282
 
# File 'lib/fusionauth/fusionauth_client.rb', line 277

def create_group_members(request)
  start.uri('/api/group/member')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse

Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.

Parameters:

  • identity_provider_id (string) —

    (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the identity provider.

Returns:



290
291
292
293
294
295
296
 
# File 'lib/fusionauth/fusionauth_client.rb', line 290

def create_identity_provider(identity_provider_id, request)
  start.uri('/api/identity-provider')
      .url_segment(identity_provider_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse

Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.

Parameters:

  • lambda_id (string) —

    (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the lambda.

Returns:



304
305
306
307
308
309
310
 
# File 'lib/fusionauth/fusionauth_client.rb', line 304

def create_lambda(lambda_id, request)
  start.uri('/api/lambda')
      .url_segment(lambda_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse

Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.

Parameters:

  • tenant_id (string) —

    (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the tenant.

Returns:



318
319
320
321
322
323
324
 
# File 'lib/fusionauth/fusionauth_client.rb', line 318

def create_tenant(tenant_id, request)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_theme(theme_id, request) ⇒ FusionAuth::ClientResponse

Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.

Parameters:

  • theme_id (string) —

    (Optional) The Id for the theme. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the theme.

Returns:



332
333
334
335
336
337
338
 
# File 'lib/fusionauth/fusionauth_client.rb', line 332

def create_theme(theme_id, request)
  start.uri('/api/theme')
      .url_segment(theme_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_user(user_id, request) ⇒ FusionAuth::ClientResponse

Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.

Parameters:

  • user_id (string) —

    (Optional) The Id for the user. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the user.

Returns:



346
347
348
349
350
351
352
 
# File 'lib/fusionauth/fusionauth_client.rb', line 346

def create_user(user_id, request)
  start.uri('/api/user')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse

Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.

Parameters:

  • user_action_id (string) —

    (Optional) The Id for the user action. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the user action.

Returns:



361
362
363
364
365
366
367
 
# File 'lib/fusionauth/fusionauth_client.rb', line 361

def create_user_action(user_action_id, request)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse

Creates a user reason. This user action reason cannot be used when actioning a user until this call completes successfully. Anytime after that the user action reason can be used.

Parameters:

  • user_action_reason_id (string) —

    (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the user action reason.

Returns:



376
377
378
379
380
381
382
 
# File 'lib/fusionauth/fusionauth_client.rb', line 376

def create_user_action_reason(user_action_reason_id, request)
  start.uri('/api/user-action-reason')
      .url_segment(user_action_reason_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse

Creates a single User consent.

Parameters:

  • user_consent_id (string) —

    (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request that contains the user consent information.

Returns:



390
391
392
393
394
395
396
 
# File 'lib/fusionauth/fusionauth_client.rb', line 390

def create_user_consent(user_consent_id, request)
  start.uri('/api/user/consent')
      .url_segment(user_consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse

Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.

Parameters:

  • webhook_id (string) —

    (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the webhook.

Returns:



404
405
406
407
408
409
410
 
# File 'lib/fusionauth/fusionauth_client.rb', line 404

def create_webhook(webhook_id, request)
  start.uri('/api/webhook')
      .url_segment(webhook_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#deactivate_application(application_id) ⇒ FusionAuth::ClientResponse

Deactivates the application with the given Id.

Parameters:

  • application_id (string) —

    The Id of the application to deactivate.

Returns:



417
418
419
420
421
422
 
# File 'lib/fusionauth/fusionauth_client.rb', line 417

def deactivate_application(application_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .delete()
      .go()
end

#deactivate_user(user_id) ⇒ FusionAuth::ClientResponse

Deactivates the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user to deactivate.

Returns:



429
430
431
432
433
434
 
# File 'lib/fusionauth/fusionauth_client.rb', line 429

def deactivate_user(user_id)
  start.uri('/api/user')
      .url_segment(user_id)
      .delete()
      .go()
end

#deactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse

Deactivates the user action with the given Id.

Parameters:

  • user_action_id (string) —

    The Id of the user action to deactivate.

Returns:



441
442
443
444
445
446
 
# File 'lib/fusionauth/fusionauth_client.rb', line 441

def deactivate_user_action(user_action_id)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .delete()
      .go()
end

#deactivate_users(user_ids) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to deactivate_users_by_ids, use that method instead.

Deactivates the users with the given ids.

Parameters:

  • user_ids (Array) —

    The ids of the users to deactivate.

Returns:



454
455
456
457
458
459
460
461
 
# File 'lib/fusionauth/fusionauth_client.rb', line 454

def deactivate_users(user_ids)
  start.uri('/api/user/bulk')
      .url_parameter('userId', user_ids)
      .url_parameter('dryRun', false)
      .url_parameter('hardDelete', false)
      .delete()
      .go()
end

#deactivate_users_by_ids(user_ids) ⇒ FusionAuth::ClientResponse

Deactivates the users with the given ids.

Parameters:

  • user_ids (Array) —

    The ids of the users to deactivate.

Returns:



468
469
470
471
472
473
474
475
 
# File 'lib/fusionauth/fusionauth_client.rb', line 468

def deactivate_users_by_ids(user_ids)
  start.uri('/api/user/bulk')
      .url_parameter('userId', user_ids)
      .url_parameter('dryRun', false)
      .url_parameter('hardDelete', false)
      .delete()
      .go()
end

#delete_application(application_id) ⇒ FusionAuth::ClientResponse

Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will delete the application, any registrations for that application, metrics and reports for the application, all the roles for the application, and any other data associated with the application. This operation could take a very long time, depending on the amount of data in your database.

Parameters:

  • application_id (string) —

    The Id of the application to delete.

Returns:



485
486
487
488
489
490
491
 
# File 'lib/fusionauth/fusionauth_client.rb', line 485

def delete_application(application_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_parameter('hardDelete', true)
      .delete()
      .go()
end

#delete_application_role(application_id, role_id) ⇒ FusionAuth::ClientResponse

Hard deletes an application role. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given role from all users that had it.

Parameters:

  • application_id (string) —

    The Id of the application to deactivate.

  • role_id (string) —

    The Id of the role to delete.

Returns:



500
501
502
503
504
505
506
507
 
# File 'lib/fusionauth/fusionauth_client.rb', line 500

def delete_application_role(application_id, role_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("role")
      .url_segment(role_id)
      .delete()
      .go()
end

#delete_connector(connector_id) ⇒ FusionAuth::ClientResponse

Deletes the connector for the given Id.

Parameters:

  • connector_id (string) —

    The Id of the connector to delete.

Returns:



514
515
516
517
518
519
 
# File 'lib/fusionauth/fusionauth_client.rb', line 514

def delete_connector(connector_id)
  start.uri('/api/connector')
      .url_segment(connector_id)
      .delete()
      .go()
end

#delete_consent(consent_id) ⇒ FusionAuth::ClientResponse

Deletes the consent for the given Id.

Parameters:

  • consent_id (string) —

    The Id of the consent to delete.

Returns:



526
527
528
529
530
531
 
# File 'lib/fusionauth/fusionauth_client.rb', line 526

def delete_consent(consent_id)
  start.uri('/api/consent')
      .url_segment(consent_id)
      .delete()
      .go()
end

#delete_email_template(email_template_id) ⇒ FusionAuth::ClientResponse

Deletes the email template for the given Id.

Parameters:

  • email_template_id (string) —

    The Id of the email template to delete.

Returns:



538
539
540
541
542
543
 
# File 'lib/fusionauth/fusionauth_client.rb', line 538

def delete_email_template(email_template_id)
  start.uri('/api/email/template')
      .url_segment(email_template_id)
      .delete()
      .go()
end

#delete_form(form_id) ⇒ FusionAuth::ClientResponse

Deletes the form for the given Id.

Parameters:

  • form_id (string) —

    The Id of the form to delete.

Returns:



550
551
552
553
554
555
 
# File 'lib/fusionauth/fusionauth_client.rb', line 550

def delete_form(form_id)
  start.uri('/api/form')
      .url_segment(form_id)
      .delete()
      .go()
end

#delete_form_field(field_id) ⇒ FusionAuth::ClientResponse

Deletes the form field for the given Id.

Parameters:

  • field_id (string) —

    The Id of the form field to delete.

Returns:



562
563
564
565
566
567
 
# File 'lib/fusionauth/fusionauth_client.rb', line 562

def delete_form_field(field_id)
  start.uri('/api/form/field')
      .url_segment(field_id)
      .delete()
      .go()
end

#delete_group(group_id) ⇒ FusionAuth::ClientResponse

Deletes the group for the given Id.

Parameters:

  • group_id (string) —

    The Id of the group to delete.

Returns:



574
575
576
577
578
579
 
# File 'lib/fusionauth/fusionauth_client.rb', line 574

def delete_group(group_id)
  start.uri('/api/group')
      .url_segment(group_id)
      .delete()
      .go()
end

#delete_group_members(request) ⇒ FusionAuth::ClientResponse

Removes users as members of a group.

Parameters:

  • request (OpenStruct, Hash) —

    The member request that contains all of the information used to remove members to the group.

Returns:



586
587
588
589
590
591
 
# File 'lib/fusionauth/fusionauth_client.rb', line 586

def delete_group_members(request)
  start.uri('/api/group/member')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .delete()
      .go()
end

#delete_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse

Deletes the identity provider for the given Id.

Parameters:

  • identity_provider_id (string) —

    The Id of the identity provider to delete.

Returns:



598
599
600
601
602
603
 
# File 'lib/fusionauth/fusionauth_client.rb', line 598

def delete_identity_provider(identity_provider_id)
  start.uri('/api/identity-provider')
      .url_segment(identity_provider_id)
      .delete()
      .go()
end

#delete_key(key_id) ⇒ FusionAuth::ClientResponse

Deletes the key for the given Id.

Parameters:

  • key_id (string) —

    The Id of the key to delete.

Returns:



610
611
612
613
614
615
 
# File 'lib/fusionauth/fusionauth_client.rb', line 610

def delete_key(key_id)
  start.uri('/api/key')
      .url_segment(key_id)
      .delete()
      .go()
end

#delete_lambda(lambda_id) ⇒ FusionAuth::ClientResponse

Deletes the lambda for the given Id.

Parameters:

  • lambda_id (string) —

    The Id of the lambda to delete.

Returns:



622
623
624
625
626
627
 
# File 'lib/fusionauth/fusionauth_client.rb', line 622

def delete_lambda(lambda_id)
  start.uri('/api/lambda')
      .url_segment(lambda_id)
      .delete()
      .go()
end

#delete_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse

Deletes the user registration for the given user and application.

Parameters:

  • user_id (string) —

    The Id of the user whose registration is being deleted.

  • application_id (string) —

    The Id of the application to remove the registration for.

Returns:



635
636
637
638
639
640
641
 
# File 'lib/fusionauth/fusionauth_client.rb', line 635

def delete_registration(user_id, application_id)
  start.uri('/api/user/registration')
      .url_segment(user_id)
      .url_segment(application_id)
      .delete()
      .go()
end

#delete_tenant(tenant_id) ⇒ FusionAuth::ClientResponse

Deletes the tenant for the given Id.

Parameters:

  • tenant_id (string) —

    The Id of the tenant to delete.

Returns:



648
649
650
651
652
653
 
# File 'lib/fusionauth/fusionauth_client.rb', line 648

def delete_tenant(tenant_id)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .delete()
      .go()
end

#delete_tenant_async(tenant_id) ⇒ FusionAuth::ClientResponse

Deletes the tenant for the given Id asynchronously. This method is helpful if you do not want to wait for the delete operation to complete.

Parameters:

  • tenant_id (string) —

    The Id of the tenant to delete.

Returns:



661
662
663
664
665
666
667
 
# File 'lib/fusionauth/fusionauth_client.rb', line 661

def delete_tenant_async(tenant_id)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .url_parameter('async', true)
      .delete()
      .go()
end

#delete_theme(theme_id) ⇒ FusionAuth::ClientResponse

Deletes the theme for the given Id.

Parameters:

  • theme_id (string) —

    The Id of the theme to delete.

Returns:



674
675
676
677
678
679
 
# File 'lib/fusionauth/fusionauth_client.rb', line 674

def delete_theme(theme_id)
  start.uri('/api/theme')
      .url_segment(theme_id)
      .delete()
      .go()
end

#delete_user(user_id) ⇒ FusionAuth::ClientResponse

Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user.

Parameters:

  • user_id (string) —

    The Id of the user to delete.

Returns:



687
688
689
690
691
692
693
 
# File 'lib/fusionauth/fusionauth_client.rb', line 687

def delete_user(user_id)
  start.uri('/api/user')
      .url_segment(user_id)
      .url_parameter('hardDelete', true)
      .delete()
      .go()
end

#delete_user_action(user_action_id) ⇒ FusionAuth::ClientResponse

Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users.

Parameters:

  • user_action_id (string) —

    The Id of the user action to delete.

Returns:



701
702
703
704
705
706
707
 
# File 'lib/fusionauth/fusionauth_client.rb', line 701

def delete_user_action(user_action_id)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .url_parameter('hardDelete', true)
      .delete()
      .go()
end

#delete_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse

Deletes the user action reason for the given Id.

Parameters:

  • user_action_reason_id (string) —

    The Id of the user action reason to delete.

Returns:



714
715
716
717
718
719
 
# File 'lib/fusionauth/fusionauth_client.rb', line 714

def delete_user_action_reason(user_action_reason_id)
  start.uri('/api/user-action-reason')
      .url_segment(user_action_reason_id)
      .delete()
      .go()
end

#delete_users(request) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to delete_users_by_query, use that method instead.

Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

Parameters:

  • request (OpenStruct, Hash) —

    The UserDeleteRequest.

Returns:



731
732
733
734
735
736
 
# File 'lib/fusionauth/fusionauth_client.rb', line 731

def delete_users(request)
  start.uri('/api/user/bulk')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .delete()
      .go()
end

#delete_users_by_query(request) ⇒ FusionAuth::ClientResponse

Deletes the users with the given ids, or users matching the provided JSON query or queryString. The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.

This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.

Parameters:

  • request (OpenStruct, Hash) —

    The UserDeleteRequest.

Returns:



747
748
749
750
751
752
 
# File 'lib/fusionauth/fusionauth_client.rb', line 747

def delete_users_by_query(request)
  start.uri('/api/user/bulk')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .delete()
      .go()
end

#delete_webhook(webhook_id) ⇒ FusionAuth::ClientResponse

Deletes the webhook for the given Id.

Parameters:

  • webhook_id (string) —

    The Id of the webhook to delete.

Returns:



759
760
761
762
763
764
 
# File 'lib/fusionauth/fusionauth_client.rb', line 759

def delete_webhook(webhook_id)
  start.uri('/api/webhook')
      .url_segment(webhook_id)
      .delete()
      .go()
end

#disable_two_factor(user_id, code) ⇒ FusionAuth::ClientResponse

Disable Two Factor authentication for a user.

Parameters:

  • user_id (string) —

    The Id of the User for which you’re disabling Two Factor authentication.

  • code (string) —

    The Two Factor code used verify the the caller knows the Two Factor secret.

Returns:



772
773
774
775
776
777
778
 
# File 'lib/fusionauth/fusionauth_client.rb', line 772

def disable_two_factor(user_id, code)
  start.uri('/api/user/two-factor')
      .url_parameter('userId', user_id)
      .url_parameter('code', code)
      .delete()
      .go()
end

#enable_two_factor(user_id, request) ⇒ FusionAuth::ClientResponse

Enable Two Factor authentication for a user.

Parameters:

  • user_id (string) —

    The Id of the user to enable Two Factor authentication.

  • request (OpenStruct, Hash) —

    The two factor enable request information.

Returns:



786
787
788
789
790
791
792
 
# File 'lib/fusionauth/fusionauth_client.rb', line 786

def enable_two_factor(user_id, request)
  start.uri('/api/user/two-factor')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri) ⇒ FusionAuth::ClientResponse

Exchanges an OAuth authorization code for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.

Parameters:

  • code (string) —

    The authorization code returned on the /oauth2/authorize response.

  • client_id (string) —

    The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate.

  • client_secret (string) —

    (Optional) The client secret. This value will be required if client authentication is enabled.

  • redirect_uri (string) —

    The URI to redirect to upon a successful request.

Returns:



803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/fusionauth/fusionauth_client.rb', line 803

def exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri)
  body = {
    "code" => code,
    "client_id" => client_id,
    "client_secret" => client_secret,
    "grant_type" => "authorization_code",
    "redirect_uri" => redirect_uri
  }
  startAnonymous.uri('/oauth2/token')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post()
      .go()
end

#exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier) ⇒ FusionAuth::ClientResponse

Exchanges an OAuth authorization code and code_verifier for an access token. Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.

Parameters:

  • code (string) —

    The authorization code returned on the /oauth2/authorize response.

  • client_id (string) —

    (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.

  • client_secret (string) —

    (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.

  • redirect_uri (string) —

    The URI to redirect to upon a successful request.

  • code_verifier (string) —

    The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.

Returns:



827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/fusionauth/fusionauth_client.rb', line 827

def exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier)
  body = {
    "code" => code,
    "client_id" => client_id,
    "client_secret" => client_secret,
    "grant_type" => "authorization_code",
    "redirect_uri" => redirect_uri,
    "code_verifier" => code_verifier
  }
  startAnonymous.uri('/oauth2/token')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post()
      .go()
end

#exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse

Exchange a Refresh Token for an Access Token. If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.

Parameters:

  • refresh_token (string) —

    The refresh token that you would like to use to exchange for an access token.

  • client_id (string) —

    (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.

  • client_secret (string) —

    (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.

  • scope (string) —

    (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.

  • user_code (string) —

    (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

Returns:



852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/fusionauth/fusionauth_client.rb', line 852

def exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code)
  body = {
    "refresh_token" => refresh_token,
    "client_id" => client_id,
    "client_secret" => client_secret,
    "grant_type" => "refresh_token",
    "scope" => scope,
    "user_code" => user_code
  }
  startAnonymous.uri('/oauth2/token')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post()
      .go()
end

#exchange_refresh_token_for_jwt(request) ⇒ FusionAuth::ClientResponse

Exchange a refresh token for a new JWT.

Parameters:

  • request (OpenStruct, Hash) —

    The refresh request.

Returns:



872
873
874
875
876
877
 
# File 'lib/fusionauth/fusionauth_client.rb', line 872

def exchange_refresh_token_for_jwt(request)
  startAnonymous.uri('/api/jwt/refresh')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code) ⇒ FusionAuth::ClientResponse

Exchange User Credentials for a Token. If you will be using the Resource Owner Password Credential Grant, you will make a request to the Token endpoint to exchange the user’s email and password for an access token.

Parameters:

  • username (string) —

    The login identifier of the user. The login identifier can be either the email or the username.

  • password (string) —

    The user’s password.

  • client_id (string) —

    (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.

  • client_secret (string) —

    (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.

  • scope (string) —

    (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.

  • user_code (string) —

    (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.

Returns:



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/fusionauth/fusionauth_client.rb', line 890

def exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code)
  body = {
    "username" => username,
    "password" => password,
    "client_id" => client_id,
    "client_secret" => client_secret,
    "grant_type" => "password",
    "scope" => scope,
    "user_code" => user_code
  }
  startAnonymous.uri('/oauth2/token')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post()
      .go()
end

#forgot_password(request) ⇒ FusionAuth::ClientResponse

Begins the forgot password sequence, which kicks off an email to the user so that they can reset their password.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the information about the user so that they can be emailed.

Returns:



911
912
913
914
915
916
 
# File 'lib/fusionauth/fusionauth_client.rb', line 911

def forgot_password(request)
  start.uri('/api/user/forgot-password')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#generate_email_verification_id(email) ⇒ FusionAuth::ClientResponse

Generate a new Email Verification Id to be used with the Verify Email API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system.

Parameters:

  • email (string) —

    The email address of the user that needs a new verification email.

Returns:



924
925
926
927
928
929
930
 
# File 'lib/fusionauth/fusionauth_client.rb', line 924

def generate_email_verification_id(email)
  start.uri('/api/user/verify-email')
      .url_parameter('email', email)
      .url_parameter('sendVerifyEmail', false)
      .put()
      .go()
end

#generate_key(key_id, request) ⇒ FusionAuth::ClientResponse

Generate a new RSA or EC key pair or an HMAC secret.

Parameters:

  • key_id (string) —

    (Optional) The Id for the key. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the key.

Returns:



938
939
940
941
942
943
944
 
# File 'lib/fusionauth/fusionauth_client.rb', line 938

def generate_key(key_id, request)
  start.uri('/api/key/generate')
      .url_segment(key_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#generate_registration_verification_id(email, application_id) ⇒ FusionAuth::ClientResponse

Generate a new Application Registration Verification Id to be used with the Verify Registration API. This API will not attempt to send an email to the User. This API may be used to collect the verificationId for use with a third party system.

Parameters:

  • email (string) —

    The email address of the user that needs a new verification email.

  • application_id (string) —

    The Id of the application to be verified.

Returns:



953
954
955
956
957
958
959
960
 
# File 'lib/fusionauth/fusionauth_client.rb', line 953

def generate_registration_verification_id(email, application_id)
  start.uri('/api/user/verify-registration')
      .url_parameter('email', email)
      .url_parameter('sendVerifyPasswordEmail', false)
      .url_parameter('applicationId', application_id)
      .put()
      .go()
end

#generate_two_factor_secret ⇒ FusionAuth::ClientResponse

Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

Returns:



968
969
970
971
972
 
# File 'lib/fusionauth/fusionauth_client.rb', line 968

def generate_two_factor_secret()
  start.uri('/api/two-factor/secret')
      .get()
      .go()
end

#generate_two_factor_secret_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse

Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator.

Parameters:

  • encoded_jwt (string) —

    The encoded JWT (access token).

Returns:



981
982
983
984
985
986
 
# File 'lib/fusionauth/fusionauth_client.rb', line 981

def generate_two_factor_secret_using_jwt(encoded_jwt)
  startAnonymous.uri('/api/two-factor/secret')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#identity_provider_login(request) ⇒ FusionAuth::ClientResponse

Handles login via third-parties including Social login, external OAuth and OpenID Connect, and other login systems.

Parameters:

  • request (OpenStruct, Hash) —

    The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user’s account.

Returns:



995
996
997
998
999
1000
 
# File 'lib/fusionauth/fusionauth_client.rb', line 995

def (request)
  startAnonymous.uri('/api/identity-provider/login')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#import_key(key_id, request) ⇒ FusionAuth::ClientResponse

Import an existing RSA or EC key pair or an HMAC secret.

Parameters:

  • key_id (string) —

    (Optional) The Id for the key. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to create the key.

Returns:



1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1008

def import_key(key_id, request)
  start.uri('/api/key/import')
      .url_segment(key_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#import_refresh_tokens(request) ⇒ FusionAuth::ClientResponse

Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains all of the information about all of the refresh tokens to import.

Returns:



1028
1029
1030
1031
1032
1033
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1028

def import_refresh_tokens(request)
  start.uri('/api/user/refresh-token/import')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#import_users(request) ⇒ FusionAuth::ClientResponse

Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to increases the insert performance.

Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See the validateDbConstraints request parameter.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains all of the information about all of the users to import.

Returns:



1047
1048
1049
1050
1051
1052
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1047

def import_users(request)
  start.uri('/api/user/import')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#introspect_access_token(client_id, token) ⇒ FusionAuth::ClientResponse

Inspect an access token issued by FusionAuth.

Parameters:

  • client_id (string) —

    The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.

  • token (string) —

    The access token returned by this OAuth provider as the result of a successful authentication.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1060

def introspect_access_token(client_id, token)
  body = {
    "client_id" => client_id,
    "token" => token
  }
  startAnonymous.uri('/oauth2/introspect')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post()
      .go()
end

#issue_jwt(application_id, encoded_jwt, refresh_token) ⇒ FusionAuth::ClientResponse

Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid access token is properly signed and not expired. <p> This API may be used in an SSO configuration to issue new tokens for another application after the user has obtained a valid token from authentication.

Parameters:

  • application_id (string) —

    The Application Id for which you are requesting a new access token be issued.

  • encoded_jwt (string) —

    The encoded JWT (access token).

  • refresh_token (string) —

    (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response. <p>The target application represented by the applicationId request parameter must have refresh tokens enabled in order to receive a refresh token in the response.</p>

Returns:



1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1084

def issue_jwt(application_id, encoded_jwt, refresh_token)
  startAnonymous.uri('/api/jwt/issue')
      .authorization('Bearer ' + encoded_jwt)
      .url_parameter('applicationId', application_id)
      .url_parameter('refreshToken', refresh_token)
      .get()
      .go()
end

#login(request) ⇒ FusionAuth::ClientResponse

Authenticates a user to FusionAuth.

This API optionally requires an API key. See Application.loginConfiguration.requireAuthentication.

Parameters:

  • request (OpenStruct, Hash) —

    The login request that contains the user credentials used to log them in.

Returns:



1100
1101
1102
1103
1104
1105
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1100

def (request)
  start.uri('/api/login')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#login_ping(user_id, application_id, caller_ip_address) ⇒ FusionAuth::ClientResponse

Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using FusionAuth’s SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.

Parameters:

  • user_id (string) —

    The Id of the user that was logged in.

  • application_id (string) —

    The Id of the application that they logged into.

  • caller_ip_address (string) —

    (Optional) The IP address of the end-user that is logging in. If a null value is provided the IP address will be that of the client or last proxy that sent the request.

Returns:



1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1118

def (user_id, application_id, caller_ip_address)
  start.uri('/api/login')
      .url_segment(user_id)
      .url_segment(application_id)
      .url_parameter('ipAddress', caller_ip_address)
      .put()
      .go()
end

#logout(global, refresh_token) ⇒ FusionAuth::ClientResponse

The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies.

Parameters:

  • global (Boolean) —

    When this value is set to true all of the refresh tokens issued to the owner of the provided token will be revoked.

  • refresh_token (string) —

    (Optional) The refresh_token as a request parameter instead of coming in via a cookie. If provided this takes precedence over the cookie.

Returns:



1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1137

def logout(global, refresh_token)
  startAnonymous.uri('/api/logout')
      .url_parameter('global', global)
      .url_parameter('refreshToken', refresh_token)
      .post()
      .go()
end

#lookup_identity_provider(domain) ⇒ FusionAuth::ClientResponse

Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed by a registered identity provider. A 404 indicates the domain is not managed.

Parameters:

  • domain (string) —

    The domain or email address to lookup.

Returns:



1151
1152
1153
1154
1155
1156
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1151

def lookup_identity_provider(domain)
  start.uri('/api/identity-provider/lookup')
      .url_parameter('domain', domain)
      .get()
      .go()
end

#modify_action(action_id, request) ⇒ FusionAuth::ClientResponse

Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the action.

Parameters:

  • action_id (string) —

    The Id of the action to modify. This is technically the user action log id.

  • request (OpenStruct, Hash) —

    The request that contains all of the information about the modification.

Returns:



1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1165

def modify_action(action_id, request)
  start.uri('/api/user/action')
      .url_segment(action_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#passwordless_login(request) ⇒ FusionAuth::ClientResponse

Complete a login request using a passwordless code

Parameters:

  • request (OpenStruct, Hash) —

    The passwordless login request that contains all of the information used to complete login.

Returns:



1178
1179
1180
1181
1182
1183
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1178

def (request)
  startAnonymous.uri('/api/passwordless/login')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#patch_application(application_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the application with the given Id.

Parameters:

  • application_id (string) —

    The Id of the application to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new application information.

Returns:



1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1191

def patch_application(application_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the application role with the given id for the application.

Parameters:

  • application_id (string) —

    The Id of the application that the role belongs to.

  • role_id (string) —

    The Id of the role to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new role information.

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1206

def patch_application_role(application_id, role_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("role")
      .url_segment(role_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_connector(connector_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the connector with the given Id.

Parameters:

  • connector_id (string) —

    The Id of the connector to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new connector information.

Returns:



1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1222

def patch_connector(connector_id, request)
  start.uri('/api/connector')
      .url_segment(connector_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_consent(consent_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the consent with the given Id.

Parameters:

  • consent_id (string) —

    The Id of the consent to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new consent information.

Returns:



1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1236

def patch_consent(consent_id, request)
  start.uri('/api/consent')
      .url_segment(consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the email template with the given Id.

Parameters:

  • email_template_id (string) —

    The Id of the email template to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new email template information.

Returns:



1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1250

def patch_email_template(email_template_id, request)
  start.uri('/api/email/template')
      .url_segment(email_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_group(group_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the group with the given Id.

Parameters:

  • group_id (string) —

    The Id of the group to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new group information.

Returns:



1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1264

def patch_group(group_id, request)
  start.uri('/api/group')
      .url_segment(group_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the identity provider with the given Id.

Parameters:

  • identity_provider_id (string) —

    The Id of the identity provider to update.

  • request (OpenStruct, Hash) —

    The request object that contains just the updated identity provider information.

Returns:



1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1278

def patch_identity_provider(identity_provider_id, request)
  start.uri('/api/identity-provider')
      .url_segment(identity_provider_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_integrations(request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the available integrations.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains just the new integration information.

Returns:



1291
1292
1293
1294
1295
1296
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1291

def patch_integrations(request)
  start.uri('/api/integration')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the lambda with the given Id.

Parameters:

  • lambda_id (string) —

    The Id of the lambda to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new lambda information.

Returns:



1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1304

def patch_lambda(lambda_id, request)
  start.uri('/api/lambda')
      .url_segment(lambda_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_registration(user_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the registration for the user with the given id and the application defined in the request.

Parameters:

  • user_id (string) —

    The Id of the user whose registration is going to be updated.

  • request (OpenStruct, Hash) —

    The request that contains just the new registration information.

Returns:



1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1318

def patch_registration(user_id, request)
  start.uri('/api/user/registration')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_system_configuration(request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the system configuration.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains just the new system configuration information.

Returns:



1331
1332
1333
1334
1335
1336
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1331

def patch_system_configuration(request)
  start.uri('/api/system-configuration')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the tenant with the given Id.

Parameters:

  • tenant_id (string) —

    The Id of the tenant to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new tenant information.

Returns:



1344
1345
1346
1347
1348
1349
1350
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1344

def patch_tenant(tenant_id, request)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_theme(theme_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the theme with the given Id.

Parameters:

  • theme_id (string) —

    The Id of the theme to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new theme information.

Returns:



1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1358

def patch_theme(theme_id, request)
  start.uri('/api/theme')
      .url_segment(theme_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_user(user_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new user information.

Returns:



1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1372

def patch_user(user_id, request)
  start.uri('/api/user')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the user action with the given Id.

Parameters:

  • user_action_id (string) —

    The Id of the user action to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new user action information.

Returns:



1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1386

def patch_user_action(user_action_id, request)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the user action reason with the given Id.

Parameters:

  • user_action_reason_id (string) —

    The Id of the user action reason to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new user action reason information.

Returns:



1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1400

def patch_user_action_reason(user_action_reason_id, request)
  start.uri('/api/user-action-reason')
      .url_segment(user_action_reason_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, a single User consent by Id.

Parameters:

  • user_consent_id (string) —

    The User Consent Id

  • request (OpenStruct, Hash) —

    The request that contains just the new user consent information.

Returns:



1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1414

def patch_user_consent(user_consent_id, request)
  start.uri('/api/user/consent')
      .url_segment(user_consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#reactivate_application(application_id) ⇒ FusionAuth::ClientResponse

Reactivates the application with the given Id.

Parameters:

  • application_id (string) —

    The Id of the application to reactivate.

Returns:



1427
1428
1429
1430
1431
1432
1433
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1427

def reactivate_application(application_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_parameter('reactivate', true)
      .put()
      .go()
end

#reactivate_user(user_id) ⇒ FusionAuth::ClientResponse

Reactivates the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user to reactivate.

Returns:



1440
1441
1442
1443
1444
1445
1446
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1440

def reactivate_user(user_id)
  start.uri('/api/user')
      .url_segment(user_id)
      .url_parameter('reactivate', true)
      .put()
      .go()
end

#reactivate_user_action(user_action_id) ⇒ FusionAuth::ClientResponse

Reactivates the user action with the given Id.

Parameters:

  • user_action_id (string) —

    The Id of the user action to reactivate.

Returns:



1453
1454
1455
1456
1457
1458
1459
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1453

def reactivate_user_action(user_action_id)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .url_parameter('reactivate', true)
      .put()
      .go()
end

#reconcile_jwt(request) ⇒ FusionAuth::ClientResponse

Reconcile a User to FusionAuth using JWT issued from another Identity Provider.

Parameters:

  • request (OpenStruct, Hash) —

    The reconcile request that contains the data to reconcile the User.

Returns:



1466
1467
1468
1469
1470
1471
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1466

def reconcile_jwt(request)
  startAnonymous.uri('/api/jwt/reconcile')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#refresh_user_search_index ⇒ FusionAuth::ClientResponse

Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to

ensure the index immediately current before making a query request to the search index.

Returns:



1480
1481
1482
1483
1484
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1480

def refresh_user_search_index()
  start.uri('/api/user/search')
      .put()
      .go()
end

#register(user_id, request) ⇒ FusionAuth::ClientResponse

Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.

Parameters:

  • user_id (string) —

    (Optional) The Id of the user being registered for the application and optionally created.

  • request (OpenStruct, Hash) —

    The request that optionally contains the User and must contain the UserRegistration.

Returns:



1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1496

def register(user_id, request)
  start.uri('/api/user/registration')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#remove_user_from_family(family_id, user_id) ⇒ FusionAuth::ClientResponse

Removes a user from the family with the given id.

Parameters:

  • family_id (string) —

    The id of the family to remove the user from.

  • user_id (string) —

    The id of the user to remove from the family.

Returns:



1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1510

def remove_user_from_family(family_id, user_id)
  start.uri('/api/user/family')
      .url_segment(family_id)
      .url_segment(user_id)
      .delete()
      .go()
end

#resend_email_verification(email) ⇒ FusionAuth::ClientResponse

Re-sends the verification email to the user.

Parameters:

  • email (string) —

    The email address of the user that needs a new verification email.

Returns:



1523
1524
1525
1526
1527
1528
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1523

def resend_email_verification(email)
  start.uri('/api/user/verify-email')
      .url_parameter('email', email)
      .put()
      .go()
end

#resend_email_verification_with_application_template(application_id, email) ⇒ FusionAuth::ClientResponse

Re-sends the verification email to the user. If the Application has configured a specific email template this will be used instead of the tenant configuration.

Parameters:

  • application_id (string) —

    The unique Application Id to used to resolve an application specific email template.

  • email (string) —

    The email address of the user that needs a new verification email.

Returns:



1537
1538
1539
1540
1541
1542
1543
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1537

def resend_email_verification_with_application_template(application_id, email)
  start.uri('/api/user/verify-email')
      .url_parameter('applicationId', application_id)
      .url_parameter('email', email)
      .put()
      .go()
end

#resend_registration_verification(email, application_id) ⇒ FusionAuth::ClientResponse

Re-sends the application registration verification email to the user.

Parameters:

  • email (string) —

    The email address of the user that needs a new verification email.

  • application_id (string) —

    The Id of the application to be verified.

Returns:



1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1551

def resend_registration_verification(email, application_id)
  start.uri('/api/user/verify-registration')
      .url_parameter('email', email)
      .url_parameter('applicationId', application_id)
      .put()
      .go()
end

#retrieve_action(action_id) ⇒ FusionAuth::ClientResponse

Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.

Parameters:

  • action_id (string) —

    The Id of the action to retrieve.

Returns:



1564
1565
1566
1567
1568
1569
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1564

def retrieve_action(action_id)
  start.uri('/api/user/action')
      .url_segment(action_id)
      .get()
      .go()
end

#retrieve_actions(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions.

Parameters:

  • user_id (string) —

    The Id of the user to fetch the actions for.

Returns:



1577
1578
1579
1580
1581
1582
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1577

def retrieve_actions(user_id)
  start.uri('/api/user/action')
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_actions_preventing_login(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.

Parameters:

  • user_id (string) —

    The Id of the user to fetch the actions for.

Returns:



1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1589

def (user_id)
  start.uri('/api/user/action')
      .url_parameter('userId', user_id)
      .url_parameter('preventingLogin', true)
      .get()
      .go()
end

#retrieve_active_actions(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended.

Parameters:

  • user_id (string) —

    The Id of the user to fetch the actions for.

Returns:



1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1603

def retrieve_active_actions(user_id)
  start.uri('/api/user/action')
      .url_parameter('userId', user_id)
      .url_parameter('active', true)
      .get()
      .go()
end

#retrieve_application(application_id) ⇒ FusionAuth::ClientResponse

Retrieves the application for the given id or all of the applications if the id is null.

Parameters:

  • application_id (string) —

    (Optional) The application id.

Returns:



1616
1617
1618
1619
1620
1621
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1616

def retrieve_application(application_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .get()
      .go()
end

#retrieve_applications ⇒ FusionAuth::ClientResponse

Retrieves all of the applications.

Returns:



1627
1628
1629
1630
1631
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1627

def retrieve_applications()
  start.uri('/api/application')
      .get()
      .go()
end

#retrieve_audit_log(audit_log_id) ⇒ FusionAuth::ClientResponse

Retrieves a single audit log for the given Id.

Parameters:

  • audit_log_id (Numeric) —

    The Id of the audit log to retrieve.

Returns:



1638
1639
1640
1641
1642
1643
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1638

def retrieve_audit_log(audit_log_id)
  start.uri('/api/system/audit-log')
      .url_segment(audit_log_id)
      .get()
      .go()
end

#retrieve_connector(connector_id) ⇒ FusionAuth::ClientResponse

Retrieves the connector with the given Id.

Parameters:

  • connector_id (string) —

    The Id of the connector.

Returns:



1650
1651
1652
1653
1654
1655
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1650

def retrieve_connector(connector_id)
  start.uri('/api/connector')
      .url_segment(connector_id)
      .get()
      .go()
end

#retrieve_connectors ⇒ FusionAuth::ClientResponse

Retrieves all of the connectors.

Returns:



1661
1662
1663
1664
1665
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1661

def retrieve_connectors()
  start.uri('/api/connector')
      .get()
      .go()
end

#retrieve_consent(consent_id) ⇒ FusionAuth::ClientResponse

Retrieves the Consent for the given Id.

Parameters:

  • consent_id (string) —

    The Id of the consent.

Returns:



1672
1673
1674
1675
1676
1677
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1672

def retrieve_consent(consent_id)
  start.uri('/api/consent')
      .url_segment(consent_id)
      .get()
      .go()
end

#retrieve_consents ⇒ FusionAuth::ClientResponse

Retrieves all of the consent.

Returns:



1683
1684
1685
1686
1687
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1683

def retrieve_consents()
  start.uri('/api/consent')
      .get()
      .go()
end

#retrieve_daily_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the daily active user report between the two instants. If you specify an application id, it will only return the daily active counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1697

def retrieve_daily_active_report(application_id, start, _end)
  start.uri('/api/report/daily-active-user')
      .url_parameter('applicationId', application_id)
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_email_template(email_template_id) ⇒ FusionAuth::ClientResponse

Retrieves the email template for the given Id. If you don’t specify the id, this will return all of the email templates.

Parameters:

  • email_template_id (string) —

    (Optional) The Id of the email template.

Returns:



1711
1712
1713
1714
1715
1716
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1711

def retrieve_email_template(email_template_id)
  start.uri('/api/email/template')
      .url_segment(email_template_id)
      .get()
      .go()
end

#retrieve_email_template_preview(request) ⇒ FusionAuth::ClientResponse

Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn’t been saved to the database yet. The entire email template does not need to be provided on the request. This will create the preview based on whatever is given.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the email template and optionally a locale to render it in.

Returns:



1725
1726
1727
1728
1729
1730
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1725

def retrieve_email_template_preview(request)
  start.uri('/api/email/template/preview')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#retrieve_email_templates ⇒ FusionAuth::ClientResponse

Retrieves all of the email templates.

Returns:



1736
1737
1738
1739
1740
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1736

def retrieve_email_templates()
  start.uri('/api/email/template')
      .get()
      .go()
end

#retrieve_event_log(event_log_id) ⇒ FusionAuth::ClientResponse

Retrieves a single event log for the given Id.

Parameters:

  • event_log_id (Numeric) —

    The Id of the event log to retrieve.

Returns:



1747
1748
1749
1750
1751
1752
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1747

def retrieve_event_log(event_log_id)
  start.uri('/api/system/event-log')
      .url_segment(event_log_id)
      .get()
      .go()
end

#retrieve_families(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the families that a user belongs to.

Parameters:

  • user_id (string) —

    The User’s id

Returns:



1759
1760
1761
1762
1763
1764
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1759

def retrieve_families(user_id)
  start.uri('/api/user/family')
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_family_members_by_family_id(family_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the members of a family by the unique Family Id.

Parameters:

  • family_id (string) —

    The unique Id of the Family.

Returns:



1771
1772
1773
1774
1775
1776
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1771

def retrieve_family_members_by_family_id(family_id)
  start.uri('/api/user/family')
      .url_segment(family_id)
      .get()
      .go()
end

#retrieve_form(form_id) ⇒ FusionAuth::ClientResponse

Retrieves the form with the given Id.

Parameters:

  • form_id (string) —

    The Id of the form.

Returns:



1783
1784
1785
1786
1787
1788
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1783

def retrieve_form(form_id)
  start.uri('/api/form')
      .url_segment(form_id)
      .get()
      .go()
end

#retrieve_form_field(field_id) ⇒ FusionAuth::ClientResponse

Retrieves the form field with the given Id.

Parameters:

  • field_id (string) —

    The Id of the form field.

Returns:



1795
1796
1797
1798
1799
1800
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1795

def retrieve_form_field(field_id)
  start.uri('/api/form/field')
      .url_segment(field_id)
      .get()
      .go()
end

#retrieve_form_fields ⇒ FusionAuth::ClientResponse

Retrieves all of the forms fields

Returns:



1806
1807
1808
1809
1810
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1806

def retrieve_form_fields()
  start.uri('/api/form/field')
      .get()
      .go()
end

#retrieve_forms ⇒ FusionAuth::ClientResponse

Retrieves all of the forms.

Returns:



1816
1817
1818
1819
1820
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1816

def retrieve_forms()
  start.uri('/api/form')
      .get()
      .go()
end

#retrieve_group(group_id) ⇒ FusionAuth::ClientResponse

Retrieves the group for the given Id.

Parameters:

  • group_id (string) —

    The Id of the group.

Returns:



1827
1828
1829
1830
1831
1832
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1827

def retrieve_group(group_id)
  start.uri('/api/group')
      .url_segment(group_id)
      .get()
      .go()
end

#retrieve_groups ⇒ FusionAuth::ClientResponse

Retrieves all of the groups.

Returns:



1838
1839
1840
1841
1842
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1838

def retrieve_groups()
  start.uri('/api/group')
      .get()
      .go()
end

#retrieve_identity_provider(identity_provider_id) ⇒ FusionAuth::ClientResponse

Retrieves the identity provider for the given id or all of the identity providers if the id is null.

Parameters:

  • identity_provider_id (string) —

    The identity provider Id.

Returns:



1849
1850
1851
1852
1853
1854
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1849

def retrieve_identity_provider(identity_provider_id)
  start.uri('/api/identity-provider')
      .url_segment(identity_provider_id)
      .get()
      .go()
end

#retrieve_identity_provider_by_type(type) ⇒ FusionAuth::ClientResponse

Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request may return multiple identity providers.

Parameters:

  • type (OpenStruct, Hash) —

    The type of the identity provider.

Returns:



1863
1864
1865
1866
1867
1868
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1863

def retrieve_identity_provider_by_type(type)
  start.uri('/api/identity-provider')
      .url_parameter('type', type)
      .get()
      .go()
end

#retrieve_identity_providers ⇒ FusionAuth::ClientResponse

Retrieves all of the identity providers.

Returns:



1874
1875
1876
1877
1878
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1874

def retrieve_identity_providers()
  start.uri('/api/identity-provider')
      .get()
      .go()
end

#retrieve_inactive_actions(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based.

Parameters:

  • user_id (string) —

    The Id of the user to fetch the actions for.

Returns:



1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1886

def retrieve_inactive_actions(user_id)
  start.uri('/api/user/action')
      .url_parameter('userId', user_id)
      .url_parameter('active', false)
      .get()
      .go()
end

#retrieve_inactive_applications ⇒ FusionAuth::ClientResponse

Retrieves all of the applications that are currently inactive.

Returns:



1898
1899
1900
1901
1902
1903
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1898

def retrieve_inactive_applications()
  start.uri('/api/application')
      .url_parameter('inactive', true)
      .get()
      .go()
end

#retrieve_inactive_user_actions ⇒ FusionAuth::ClientResponse

Retrieves all of the user actions that are currently inactive.

Returns:



1909
1910
1911
1912
1913
1914
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1909

def ()
  start.uri('/api/user-action')
      .url_parameter('inactive', true)
      .get()
      .go()
end

#retrieve_integration ⇒ FusionAuth::ClientResponse

Retrieves the available integrations.

Returns:



1920
1921
1922
1923
1924
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1920

def retrieve_integration()
  start.uri('/api/integration')
      .get()
      .go()
end

#retrieve_json_web_key_set ⇒ FusionAuth::ClientResponse

Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.

Returns:



1964
1965
1966
1967
1968
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1964

def retrieve_json_web_key_set()
  startAnonymous.uri('/.well-known/jwks.json')
      .get()
      .go()
end

#retrieve_jwt_public_key(key_id) ⇒ FusionAuth::ClientResponse

Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).

Parameters:

  • key_id (string) —

    The Id of the public key (kid).

Returns:



1931
1932
1933
1934
1935
1936
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1931

def retrieve_jwt_public_key(key_id)
  startAnonymous.uri('/api/jwt/public-key')
      .url_parameter('kid', key_id)
      .get()
      .go()
end

#retrieve_jwt_public_key_by_application_id(application_id) ⇒ FusionAuth::ClientResponse

Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.

Parameters:

  • application_id (string) —

    The Id of the Application for which this key is used.

Returns:



1943
1944
1945
1946
1947
1948
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1943

def retrieve_jwt_public_key_by_application_id(application_id)
  startAnonymous.uri('/api/jwt/public-key')
      .url_parameter('applicationId', application_id)
      .get()
      .go()
end

#retrieve_jwt_public_keys ⇒ FusionAuth::ClientResponse

Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).

Returns:



1954
1955
1956
1957
1958
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1954

def retrieve_jwt_public_keys()
  startAnonymous.uri('/api/jwt/public-key')
      .get()
      .go()
end

#retrieve_key(key_id) ⇒ FusionAuth::ClientResponse

Retrieves the key for the given Id.

Parameters:

  • key_id (string) —

    The Id of the key.

Returns:



1975
1976
1977
1978
1979
1980
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1975

def retrieve_key(key_id)
  start.uri('/api/key')
      .url_segment(key_id)
      .get()
      .go()
end

#retrieve_keys ⇒ FusionAuth::ClientResponse

Retrieves all of the keys.

Returns:



1986
1987
1988
1989
1990
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1986

def retrieve_keys()
  start.uri('/api/key')
      .get()
      .go()
end

#retrieve_lambda(lambda_id) ⇒ FusionAuth::ClientResponse

Retrieves the lambda for the given Id.

Parameters:

  • lambda_id (string) —

    The Id of the lambda.

Returns:



1997
1998
1999
2000
2001
2002
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1997

def retrieve_lambda(lambda_id)
  start.uri('/api/lambda')
      .url_segment(lambda_id)
      .get()
      .go()
end

#retrieve_lambdas ⇒ FusionAuth::ClientResponse

Retrieves all of the lambdas.

Returns:



2008
2009
2010
2011
2012
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2008

def retrieve_lambdas()
  start.uri('/api/lambda')
      .get()
      .go()
end

#retrieve_lambdas_by_type(type) ⇒ FusionAuth::ClientResponse

Retrieves all of the lambdas for the provided type.

Parameters:

  • type (OpenStruct, Hash) —

    The type of the lambda to return.

Returns:



2019
2020
2021
2022
2023
2024
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2019

def retrieve_lambdas_by_type(type)
  start.uri('/api/lambda')
      .url_parameter('type', type)
      .get()
      .go()
end

#retrieve_login_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the login report between the two instants. If you specify an application id, it will only return the login counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



2034
2035
2036
2037
2038
2039
2040
2041
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2034

def (application_id, start, _end)
  start.uri('/api/report/login')
      .url_parameter('applicationId', application_id)
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_monthly_active_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the monthly active user report between the two instants. If you specify an application id, it will only return the monthly active counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2051

def retrieve_monthly_active_report(application_id, start, _end)
  start.uri('/api/report/monthly-active-user')
      .url_parameter('applicationId', application_id)
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_oauth_configuration(application_id) ⇒ FusionAuth::ClientResponse

Retrieves the Oauth2 configuration for the application for the given Application Id.

Parameters:

  • application_id (string) —

    The Id of the Application to retrieve OAuth configuration.

Returns:



2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2065

def retrieve_oauth_configuration(application_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("oauth-configuration")
      .get()
      .go()
end

#retrieve_open_id_configuration ⇒ FusionAuth::ClientResponse

Returns the well known OpenID Configuration JSON document

Returns:



2077
2078
2079
2080
2081
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2077

def retrieve_open_id_configuration()
  startAnonymous.uri('/.well-known/openid-configuration')
      .get()
      .go()
end

#retrieve_password_validation_rules ⇒ FusionAuth::ClientResponse

Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.

This API does not require an API key.

Returns:



2090
2091
2092
2093
2094
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2090

def retrieve_password_validation_rules()
  startAnonymous.uri('/api/tenant/password-validation-rules')
      .get()
      .go()
end

#retrieve_password_validation_rules_with_tenant_id(tenant_id) ⇒ FusionAuth::ClientResponse

Retrieves the password validation rules for a specific tenant.

This API does not require an API key.

Parameters:

  • tenant_id (string) —

    The Id of the tenant.

Returns:



2103
2104
2105
2106
2107
2108
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2103

def retrieve_password_validation_rules_with_tenant_id(tenant_id)
  startAnonymous.uri('/api/tenant/password-validation-rules')
      .url_segment(tenant_id)
      .get()
      .go()
end

#retrieve_pending_children(parent_email) ⇒ FusionAuth::ClientResponse

Retrieves all of the children for the given parent email address.

Parameters:

  • parent_email (string) —

    The email of the parent.

Returns:



2115
2116
2117
2118
2119
2120
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2115

def retrieve_pending_children(parent_email)
  start.uri('/api/user/family/pending')
      .url_parameter('parentEmail', parent_email)
      .get()
      .go()
end

#retrieve_recent_logins(offset, limit) ⇒ FusionAuth::ClientResponse

Retrieves the last number of login records.

Parameters:

  • offset (Numeric) —

    The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.

  • limit (Numeric) —

    (Optional, defaults to 10) The number of records to retrieve.

Returns:



2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2128

def retrieve_recent_logins(offset, limit)
  start.uri('/api/user/recent-login')
      .url_parameter('offset', offset)
      .url_parameter('limit', limit)
      .get()
      .go()
end

#retrieve_refresh_token_by_id(user_id) ⇒ FusionAuth::ClientResponse

Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..

Parameters:

  • user_id (string) —

    The Id of the user.

Returns:



2141
2142
2143
2144
2145
2146
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2141

def retrieve_refresh_token_by_id(user_id)
  start.uri('/api/jwt/refresh')
      .url_segment(user_id)
      .get()
      .go()
end

#retrieve_refresh_tokens(user_id) ⇒ FusionAuth::ClientResponse

Retrieves the refresh tokens that belong to the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user.

Returns:



2153
2154
2155
2156
2157
2158
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2153

def retrieve_refresh_tokens(user_id)
  start.uri('/api/jwt/refresh')
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_registration(user_id, application_id) ⇒ FusionAuth::ClientResponse

Retrieves the user registration for the user with the given id and the given application id.

Parameters:

  • user_id (string) —

    The Id of the user.

  • application_id (string) —

    The Id of the application.

Returns:



2166
2167
2168
2169
2170
2171
2172
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2166

def retrieve_registration(user_id, application_id)
  start.uri('/api/user/registration')
      .url_segment(user_id)
      .url_segment(application_id)
      .get()
      .go()
end

#retrieve_registration_report(application_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the registration report between the two instants. If you specify an application id, it will only return the registration counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2182

def retrieve_registration_report(application_id, start, _end)
  start.uri('/api/report/registration')
      .url_parameter('applicationId', application_id)
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_system_configuration ⇒ FusionAuth::ClientResponse

Retrieves the system configuration.

Returns:



2195
2196
2197
2198
2199
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2195

def retrieve_system_configuration()
  start.uri('/api/system-configuration')
      .get()
      .go()
end

#retrieve_tenant(tenant_id) ⇒ FusionAuth::ClientResponse

Retrieves the tenant for the given Id.

Parameters:

  • tenant_id (string) —

    The Id of the tenant.

Returns:



2206
2207
2208
2209
2210
2211
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2206

def retrieve_tenant(tenant_id)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .get()
      .go()
end

#retrieve_tenants ⇒ FusionAuth::ClientResponse

Retrieves all of the tenants.

Returns:



2217
2218
2219
2220
2221
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2217

def retrieve_tenants()
  start.uri('/api/tenant')
      .get()
      .go()
end

#retrieve_theme(theme_id) ⇒ FusionAuth::ClientResponse

Retrieves the theme for the given Id.

Parameters:

  • theme_id (string) —

    The Id of the theme.

Returns:



2228
2229
2230
2231
2232
2233
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2228

def retrieve_theme(theme_id)
  start.uri('/api/theme')
      .url_segment(theme_id)
      .get()
      .go()
end

#retrieve_themes ⇒ FusionAuth::ClientResponse

Retrieves all of the themes.

Returns:



2239
2240
2241
2242
2243
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2239

def retrieve_themes()
  start.uri('/api/theme')
      .get()
      .go()
end

#retrieve_total_report ⇒ FusionAuth::ClientResponse

Retrieves the totals report. This contains all of the total counts for each application and the global registration count.

Returns:



2250
2251
2252
2253
2254
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2250

def retrieve_total_report()
  start.uri('/api/report/totals')
      .get()
      .go()
end

#retrieve_user(user_id) ⇒ FusionAuth::ClientResponse

Retrieves the user for the given Id.

Parameters:

  • user_id (string) —

    The Id of the user.

Returns:



2261
2262
2263
2264
2265
2266
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2261

def retrieve_user(user_id)
  start.uri('/api/user')
      .url_segment(user_id)
      .get()
      .go()
end

#retrieve_user_action(user_action_id) ⇒ FusionAuth::ClientResponse

Retrieves the user action for the given Id. If you pass in null for the id, this will return all of the user actions.

Parameters:

  • user_action_id (string) —

    (Optional) The Id of the user action.

Returns:



2274
2275
2276
2277
2278
2279
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2274

def retrieve_user_action(user_action_id)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .get()
      .go()
end

#retrieve_user_action_reason(user_action_reason_id) ⇒ FusionAuth::ClientResponse

Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all of the user action reasons.

Parameters:

  • user_action_reason_id (string) —

    (Optional) The Id of the user action reason.

Returns:



2287
2288
2289
2290
2291
2292
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2287

def retrieve_user_action_reason(user_action_reason_id)
  start.uri('/api/user-action-reason')
      .url_segment(user_action_reason_id)
      .get()
      .go()
end

#retrieve_user_action_reasons ⇒ FusionAuth::ClientResponse

Retrieves all the user action reasons.

Returns:



2298
2299
2300
2301
2302
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2298

def retrieve_user_action_reasons()
  start.uri('/api/user-action-reason')
      .get()
      .go()
end

#retrieve_user_actions ⇒ FusionAuth::ClientResponse

Retrieves all of the user actions.

Returns:



2308
2309
2310
2311
2312
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2308

def ()
  start.uri('/api/user-action')
      .get()
      .go()
end

#retrieve_user_by_change_password_id(change_password_id) ⇒ FusionAuth::ClientResponse

Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user’s email or username.

Parameters:

  • change_password_id (string) —

    The unique change password Id that was sent via email or returned by the Forgot Password API.

Returns:



2320
2321
2322
2323
2324
2325
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2320

def retrieve_user_by_change_password_id(change_password_id)
  start.uri('/api/user')
      .url_parameter('changePasswordId', change_password_id)
      .get()
      .go()
end

#retrieve_user_by_email(email) ⇒ FusionAuth::ClientResponse

Retrieves the user for the given email.

Parameters:

  • email (string) —

    The email of the user.

Returns:



2332
2333
2334
2335
2336
2337
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2332

def retrieve_user_by_email(email)
  start.uri('/api/user')
      .url_parameter('email', email)
      .get()
      .go()
end

#retrieve_user_by_login_id(login_id) ⇒ FusionAuth::ClientResponse

Retrieves the user for the loginId. The loginId can be either the username or the email.

Parameters:

  • login_id (string) —

    The email or username of the user.

Returns:



2344
2345
2346
2347
2348
2349
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2344

def ()
  start.uri('/api/user')
      .url_parameter('loginId', )
      .get()
      .go()
end

#retrieve_user_by_username(username) ⇒ FusionAuth::ClientResponse

Retrieves the user for the given username.

Parameters:

  • username (string) —

    The username of the user.

Returns:



2356
2357
2358
2359
2360
2361
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2356

def retrieve_user_by_username(username)
  start.uri('/api/user')
      .url_parameter('username', username)
      .get()
      .go()
end

#retrieve_user_by_verification_id(verification_id) ⇒ FusionAuth::ClientResponse

Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user’s email or username.

Parameters:

  • verification_id (string) —

    The unique verification Id that has been set on the user object.

Returns:



2369
2370
2371
2372
2373
2374
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2369

def retrieve_user_by_verification_id(verification_id)
  start.uri('/api/user')
      .url_parameter('verificationId', verification_id)
      .get()
      .go()
end

#retrieve_user_comments(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the comments for the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user.

Returns:



2381
2382
2383
2384
2385
2386
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2381

def retrieve_user_comments(user_id)
  start.uri('/api/user/comment')
      .url_segment(user_id)
      .get()
      .go()
end

#retrieve_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse

Retrieve a single User consent by Id.

Parameters:

  • user_consent_id (string) —

    The User consent Id

Returns:



2393
2394
2395
2396
2397
2398
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2393

def retrieve_user_consent(user_consent_id)
  start.uri('/api/user/consent')
      .url_segment(user_consent_id)
      .get()
      .go()
end

#retrieve_user_consents(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all of the consents for a User.

Parameters:

  • user_id (string) —

    The User’s Id

Returns:



2405
2406
2407
2408
2409
2410
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2405

def retrieve_user_consents(user_id)
  start.uri('/api/user/consent')
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_user_info_from_access_token(encoded_jwt) ⇒ FusionAuth::ClientResponse

Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.

Parameters:

  • encoded_jwt (string) —

    The encoded JWT (access token).

Returns:



2417
2418
2419
2420
2421
2422
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2417

def (encoded_jwt)
  startAnonymous.uri('/oauth2/userinfo')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#retrieve_user_login_report(application_id, user_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the login counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • user_id (string) —

    The userId id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



2433
2434
2435
2436
2437
2438
2439
2440
2441
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2433

def (application_id, user_id, start, _end)
  start.uri('/api/report/login')
      .url_parameter('applicationId', application_id)
      .url_parameter('userId', user_id)
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_user_login_report_by_login_id(application_id, login_id, start, _end) ⇒ FusionAuth::ClientResponse

Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the login counts for that application.

Parameters:

  • application_id (string) —

    (Optional) The application id.

  • login_id (string) —

    The userId id.

  • start (OpenStruct, Hash) —

    The start instant as UTC milliseconds since Epoch.

  • _end (OpenStruct, Hash) —

    The end instant as UTC milliseconds since Epoch.

Returns:



2452
2453
2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2452

def (application_id, , start, _end)
  start.uri('/api/report/login')
      .url_parameter('applicationId', application_id)
      .url_parameter('loginId', )
      .url_parameter('start', start)
      .url_parameter('end', _end)
      .get()
      .go()
end

#retrieve_user_recent_logins(user_id, offset, limit) ⇒ FusionAuth::ClientResponse

Retrieves the last number of login records for a user.

Parameters:

  • user_id (string) —

    The Id of the user.

  • offset (Numeric) —

    The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.

  • limit (Numeric) —

    (Optional, defaults to 10) The number of records to retrieve.

Returns:



2469
2470
2471
2472
2473
2474
2475
2476
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2469

def retrieve_user_recent_logins(user_id, offset, limit)
  start.uri('/api/user/recent-login')
      .url_parameter('userId', user_id)
      .url_parameter('offset', offset)
      .url_parameter('limit', limit)
      .get()
      .go()
end

#retrieve_user_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse

Retrieves the user for the given Id. This method does not use an API key, instead it uses a JSON Web Token (JWT) for authentication.

Parameters:

  • encoded_jwt (string) —

    The encoded JWT (access token).

Returns:



2483
2484
2485
2486
2487
2488
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2483

def retrieve_user_using_jwt(encoded_jwt)
  startAnonymous.uri('/api/user')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#retrieve_webhook(webhook_id) ⇒ FusionAuth::ClientResponse

Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.

Parameters:

  • webhook_id (string) —

    (Optional) The Id of the webhook.

Returns:



2495
2496
2497
2498
2499
2500
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2495

def retrieve_webhook(webhook_id)
  start.uri('/api/webhook')
      .url_segment(webhook_id)
      .get()
      .go()
end

#retrieve_webhooks ⇒ FusionAuth::ClientResponse

Retrieves all the webhooks.

Returns:



2506
2507
2508
2509
2510
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2506

def retrieve_webhooks()
  start.uri('/api/webhook')
      .get()
      .go()
end

#revoke_refresh_token(token, user_id, application_id) ⇒ FusionAuth::ClientResponse

Revokes refresh tokens.

Usage examples:

- Delete a single refresh token, pass in only the token.
    revokeRefreshToken(token)

- Delete all refresh tokens for a user, pass in only the userId.
    revokeRefreshToken(null, userId)

- Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId.
    revokeRefreshToken(null, userId, applicationId)

- Delete all refresh tokens for an application
    revokeRefreshToken(null, null, applicationId)

Note: null may be handled differently depending upon the programming language.

See also: (method names may vary by language… but you’ll figure it out)

- revokeRefreshTokenById
- revokeRefreshTokenByToken
- revokeRefreshTokensByUserId
- revokeRefreshTokensByApplicationId
- revokeRefreshTokensByUserIdForApplication

Parameters:

  • token (string) —

    (Optional) The refresh token to delete.

  • user_id (string) —

    (Optional) The user id whose tokens to delete.

  • application_id (string) —

    (Optional) The application id of the tokens to delete.

Returns:



2542
2543
2544
2545
2546
2547
2548
2549
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2542

def revoke_refresh_token(token, user_id, application_id)
  start.uri('/api/jwt/refresh')
      .url_parameter('token', token)
      .url_parameter('userId', user_id)
      .url_parameter('applicationId', application_id)
      .delete()
      .go()
end

#revoke_refresh_token_by_id(token_id) ⇒ FusionAuth::ClientResponse

Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.

Parameters:

  • token_id (string) —

    The unique Id of the token to delete.

Returns:



2556
2557
2558
2559
2560
2561
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2556

def revoke_refresh_token_by_id(token_id)
  start.uri('/api/jwt/refresh')
      .url_segment(token_id)
      .delete()
      .go()
end

#revoke_refresh_token_by_token(token) ⇒ FusionAuth::ClientResponse

Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so be careful with this API request.

Parameters:

  • token (string) —

    The refresh token to delete.

Returns:



2568
2569
2570
2571
2572
2573
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2568

def revoke_refresh_token_by_token(token)
  start.uri('/api/jwt/refresh')
      .url_parameter('token', token)
      .delete()
      .go()
end

#revoke_refresh_tokens_by_application_id(application_id) ⇒ FusionAuth::ClientResponse

Revoke all refresh tokens that belong to an application by applicationId.

Parameters:

  • application_id (string) —

    The unique Id of the application that you want to delete all refresh tokens for.

Returns:



2580
2581
2582
2583
2584
2585
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2580

def revoke_refresh_tokens_by_application_id(application_id)
  start.uri('/api/jwt/refresh')
      .url_parameter('applicationId', application_id)
      .delete()
      .go()
end

#revoke_refresh_tokens_by_user_id(user_id) ⇒ FusionAuth::ClientResponse

Revoke all refresh tokens that belong to a user by user Id.

Parameters:

  • user_id (string) —

    The unique Id of the user that you want to delete all refresh tokens for.

Returns:



2592
2593
2594
2595
2596
2597
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2592

def revoke_refresh_tokens_by_user_id(user_id)
  start.uri('/api/jwt/refresh')
      .url_parameter('userId', user_id)
      .delete()
      .go()
end

#revoke_refresh_tokens_by_user_id_for_application(user_id, application_id) ⇒ FusionAuth::ClientResponse

Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.

Parameters:

  • user_id (string) —

    The unique Id of the user that you want to delete all refresh tokens for.

  • application_id (string) —

    The unique Id of the application that you want to delete refresh tokens for.

Returns:



2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2605

def revoke_refresh_tokens_by_user_id_for_application(user_id, application_id)
  start.uri('/api/jwt/refresh')
      .url_parameter('userId', user_id)
      .url_parameter('applicationId', application_id)
      .delete()
      .go()
end

#revoke_user_consent(user_consent_id) ⇒ FusionAuth::ClientResponse

Revokes a single User consent by Id.

Parameters:

  • user_consent_id (string) —

    The User Consent Id

Returns:



2618
2619
2620
2621
2622
2623
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2618

def revoke_user_consent(user_consent_id)
  start.uri('/api/user/consent')
      .url_segment(user_consent_id)
      .delete()
      .go()
end

#search_audit_logs(request) ⇒ FusionAuth::ClientResponse

Searches the audit logs with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



2630
2631
2632
2633
2634
2635
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2630

def search_audit_logs(request)
  start.uri('/api/system/audit-log/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#search_event_logs(request) ⇒ FusionAuth::ClientResponse

Searches the event logs with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



2642
2643
2644
2645
2646
2647
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2642

def search_event_logs(request)
  start.uri('/api/system/event-log/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#search_login_records(request) ⇒ FusionAuth::ClientResponse

Searches the login records with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



2654
2655
2656
2657
2658
2659
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2654

def (request)
  start.uri('/api/system/login-record/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#search_users(ids) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to search_users_by_ids, use that method instead.

Retrieves the users for the given ids. If any id is invalid, it is ignored.

Parameters:

  • ids (Array) —

    The user ids to search for.

Returns:



2667
2668
2669
2670
2671
2672
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2667

def search_users(ids)
  start.uri('/api/user/search')
      .url_parameter('ids', ids)
      .get()
      .go()
end

#search_users_by_ids(ids) ⇒ FusionAuth::ClientResponse

Retrieves the users for the given ids. If any id is invalid, it is ignored.

Parameters:

  • ids (Array) —

    The user ids to search for.

Returns:



2679
2680
2681
2682
2683
2684
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2679

def search_users_by_ids(ids)
  start.uri('/api/user/search')
      .url_parameter('ids', ids)
      .get()
      .go()
end

#search_users_by_query(request) ⇒ FusionAuth::ClientResponse

Retrieves the users for the given search criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields.

Returns:



2692
2693
2694
2695
2696
2697
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2692

def search_users_by_query(request)
  start.uri('/api/user/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#search_users_by_query_string(request) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to search_users_by_query, use that method instead.

Retrieves the users for the given search criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow, and sortFields.

Returns:



2706
2707
2708
2709
2710
2711
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2706

def search_users_by_query_string(request)
  start.uri('/api/user/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#send_email(email_template_id, request) ⇒ FusionAuth::ClientResponse

Send an email using an email template id. You can optionally provide requestData to access key value pairs in the email template.

Parameters:

  • email_template_id (string) —

    The id for the template.

  • request (OpenStruct, Hash) —

    The send email request that contains all of the information used to send the email.

Returns:



2720
2721
2722
2723
2724
2725
2726
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2720

def send_email(email_template_id, request)
  start.uri('/api/email/send')
      .url_segment(email_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#send_family_request_email(request) ⇒ FusionAuth::ClientResponse

Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains the parent email.

Returns:



2733
2734
2735
2736
2737
2738
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2733

def send_family_request_email(request)
  start.uri('/api/user/family/request')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#send_passwordless_code(request) ⇒ FusionAuth::ClientResponse

Send a passwordless authentication code in an email to complete login.

Parameters:

  • request (OpenStruct, Hash) —

    The passwordless send request that contains all of the information used to send an email containing a code.

Returns:



2745
2746
2747
2748
2749
2750
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2745

def send_passwordless_code(request)
  startAnonymous.uri('/api/passwordless/send')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#send_two_factor_code(request) ⇒ FusionAuth::ClientResponse

Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains all of the information used to send the code.

Returns:



2757
2758
2759
2760
2761
2762
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2757

def send_two_factor_code(request)
  start.uri('/api/two-factor/send')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#send_two_factor_code_for_login(two_factor_id) ⇒ FusionAuth::ClientResponse

Send a Two Factor authentication code to allow the completion of Two Factor authentication.

Parameters:

  • two_factor_id (string) —

    The Id returned by the Login API necessary to complete Two Factor authentication.

Returns:



2769
2770
2771
2772
2773
2774
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2769

def (two_factor_id)
  startAnonymous.uri('/api/two-factor/send')
      .url_segment(two_factor_id)
      .post()
      .go()
end

#set_tenant_id(tenant_id) ⇒ Object 



40
41
42
 
# File 'lib/fusionauth/fusionauth_client.rb', line 40

def set_tenant_id(tenant_id)
  @tenant_id = tenant_id
end

#start_identity_provider_login(request) ⇒ FusionAuth::ClientResponse

Begins a login request for a 3rd party login that requires user interaction such as HYPR.

Parameters:

  • request (OpenStruct, Hash) —

    The third-party login request that contains information from the third-party login providers that FusionAuth uses to reconcile the user’s account.

Returns:



2782
2783
2784
2785
2786
2787
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2782

def (request)
  start.uri('/api/identity-provider/start')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#start_passwordless_login(request) ⇒ FusionAuth::ClientResponse

Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.

Parameters:

  • request (OpenStruct, Hash) —

    The passwordless start request that contains all of the information used to begin the passwordless login request.

Returns:



2795
2796
2797
2798
2799
2800
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2795

def (request)
  start.uri('/api/passwordless/start')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#two_factor_login(request) ⇒ FusionAuth::ClientResponse

Complete login using a 2FA challenge

Parameters:

  • request (OpenStruct, Hash) —

    The login request that contains the user credentials used to log them in.

Returns:



2807
2808
2809
2810
2811
2812
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2807

def (request)
  startAnonymous.uri('/api/two-factor/login')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#update_application(application_id, request) ⇒ FusionAuth::ClientResponse

Updates the application with the given Id.

Parameters:

  • application_id (string) —

    The Id of the application to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new application information.

Returns:



2820
2821
2822
2823
2824
2825
2826
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2820

def update_application(application_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_application_role(application_id, role_id, request) ⇒ FusionAuth::ClientResponse

Updates the application role with the given id for the application.

Parameters:

  • application_id (string) —

    The Id of the application that the role belongs to.

  • role_id (string) —

    The Id of the role to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new role information.

Returns:



2835
2836
2837
2838
2839
2840
2841
2842
2843
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2835

def update_application_role(application_id, role_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("role")
      .url_segment(role_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_connector(connector_id, request) ⇒ FusionAuth::ClientResponse

Updates the connector with the given Id.

Parameters:

  • connector_id (string) —

    The Id of the connector to update.

  • request (OpenStruct, Hash) —

    The request object that contains all of the new connector information.

Returns:



2851
2852
2853
2854
2855
2856
2857
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2851

def update_connector(connector_id, request)
  start.uri('/api/connector')
      .url_segment(connector_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_consent(consent_id, request) ⇒ FusionAuth::ClientResponse

Updates the consent with the given Id.

Parameters:

  • consent_id (string) —

    The Id of the consent to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new consent information.

Returns:



2865
2866
2867
2868
2869
2870
2871
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2865

def update_consent(consent_id, request)
  start.uri('/api/consent')
      .url_segment(consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_email_template(email_template_id, request) ⇒ FusionAuth::ClientResponse

Updates the email template with the given Id.

Parameters:

  • email_template_id (string) —

    The Id of the email template to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new email template information.

Returns:



2879
2880
2881
2882
2883
2884
2885
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2879

def update_email_template(email_template_id, request)
  start.uri('/api/email/template')
      .url_segment(email_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_form(form_id, request) ⇒ FusionAuth::ClientResponse

Updates the form with the given Id.

Parameters:

  • form_id (string) —

    The Id of the form to update.

  • request (OpenStruct, Hash) —

    The request object that contains all of the new form information.

Returns:



2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2893

def update_form(form_id, request)
  start.uri('/api/form')
      .url_segment(form_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_form_field(field_id, request) ⇒ FusionAuth::ClientResponse

Updates the form field with the given Id.

Parameters:

  • field_id (string) —

    The Id of the form field to update.

  • request (OpenStruct, Hash) —

    The request object that contains all of the new form field information.

Returns:



2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2907

def update_form_field(field_id, request)
  start.uri('/api/form/field')
      .url_segment(field_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_group(group_id, request) ⇒ FusionAuth::ClientResponse

Updates the group with the given Id.

Parameters:

  • group_id (string) —

    The Id of the group to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new group information.

Returns:



2921
2922
2923
2924
2925
2926
2927
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2921

def update_group(group_id, request)
  start.uri('/api/group')
      .url_segment(group_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_identity_provider(identity_provider_id, request) ⇒ FusionAuth::ClientResponse

Updates the identity provider with the given Id.

Parameters:

  • identity_provider_id (string) —

    The Id of the identity provider to update.

  • request (OpenStruct, Hash) —

    The request object that contains the updated identity provider.

Returns:



2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2935

def update_identity_provider(identity_provider_id, request)
  start.uri('/api/identity-provider')
      .url_segment(identity_provider_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_integrations(request) ⇒ FusionAuth::ClientResponse

Updates the available integrations.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains all of the new integration information.

Returns:



2948
2949
2950
2951
2952
2953
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2948

def update_integrations(request)
  start.uri('/api/integration')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_key(key_id, request) ⇒ FusionAuth::ClientResponse

Updates the key with the given Id.

Parameters:

  • key_id (string) —

    The Id of the key to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new key information.

Returns:



2961
2962
2963
2964
2965
2966
2967
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2961

def update_key(key_id, request)
  start.uri('/api/key')
      .url_segment(key_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_lambda(lambda_id, request) ⇒ FusionAuth::ClientResponse

Updates the lambda with the given Id.

Parameters:

  • lambda_id (string) —

    The Id of the lambda to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new lambda information.

Returns:



2975
2976
2977
2978
2979
2980
2981
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2975

def update_lambda(lambda_id, request)
  start.uri('/api/lambda')
      .url_segment(lambda_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_registration(user_id, request) ⇒ FusionAuth::ClientResponse

Updates the registration for the user with the given id and the application defined in the request.

Parameters:

  • user_id (string) —

    The Id of the user whose registration is going to be updated.

  • request (OpenStruct, Hash) —

    The request that contains all of the new registration information.

Returns:



2989
2990
2991
2992
2993
2994
2995
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2989

def update_registration(user_id, request)
  start.uri('/api/user/registration')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_system_configuration(request) ⇒ FusionAuth::ClientResponse

Updates the system configuration.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains all of the new system configuration information.

Returns:



3002
3003
3004
3005
3006
3007
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3002

def update_system_configuration(request)
  start.uri('/api/system-configuration')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_tenant(tenant_id, request) ⇒ FusionAuth::ClientResponse

Updates the tenant with the given Id.

Parameters:

  • tenant_id (string) —

    The Id of the tenant to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new tenant information.

Returns:



3015
3016
3017
3018
3019
3020
3021
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3015

def update_tenant(tenant_id, request)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_theme(theme_id, request) ⇒ FusionAuth::ClientResponse

Updates the theme with the given Id.

Parameters:

  • theme_id (string) —

    The Id of the theme to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new theme information.

Returns:



3029
3030
3031
3032
3033
3034
3035
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3029

def update_theme(theme_id, request)
  start.uri('/api/theme')
      .url_segment(theme_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_user(user_id, request) ⇒ FusionAuth::ClientResponse

Updates the user with the given Id.

Parameters:

  • user_id (string) —

    The Id of the user to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new user information.

Returns:



3043
3044
3045
3046
3047
3048
3049
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3043

def update_user(user_id, request)
  start.uri('/api/user')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_user_action(user_action_id, request) ⇒ FusionAuth::ClientResponse

Updates the user action with the given Id.

Parameters:

  • user_action_id (string) —

    The Id of the user action to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new user action information.

Returns:



3057
3058
3059
3060
3061
3062
3063
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3057

def update_user_action(user_action_id, request)
  start.uri('/api/user-action')
      .url_segment(user_action_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_user_action_reason(user_action_reason_id, request) ⇒ FusionAuth::ClientResponse

Updates the user action reason with the given Id.

Parameters:

  • user_action_reason_id (string) —

    The Id of the user action reason to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new user action reason information.

Returns:



3071
3072
3073
3074
3075
3076
3077
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3071

def update_user_action_reason(user_action_reason_id, request)
  start.uri('/api/user-action-reason')
      .url_segment(user_action_reason_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_user_consent(user_consent_id, request) ⇒ FusionAuth::ClientResponse

Updates a single User consent by Id.

Parameters:

  • user_consent_id (string) —

    The User Consent Id

  • request (OpenStruct, Hash) —

    The request that contains the user consent information.

Returns:



3085
3086
3087
3088
3089
3090
3091
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3085

def update_user_consent(user_consent_id, request)
  start.uri('/api/user/consent')
      .url_segment(user_consent_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_webhook(webhook_id, request) ⇒ FusionAuth::ClientResponse

Updates the webhook with the given Id.

Parameters:

  • webhook_id (string) —

    The Id of the webhook to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new webhook information.

Returns:



3099
3100
3101
3102
3103
3104
3105
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3099

def update_webhook(webhook_id, request)
  start.uri('/api/webhook')
      .url_segment(webhook_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#validate_device(user_code, client_id) ⇒ FusionAuth::ClientResponse

Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant. If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.

Parameters:

  • user_code (string) —

    The end-user verification code.

  • client_id (string) —

    The client id.

Returns:



3114
3115
3116
3117
3118
3119
3120
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3114

def validate_device(user_code, client_id)
  startAnonymous.uri('/oauth2/device/validate')
      .url_parameter('user_code', user_code)
      .url_parameter('client_id', client_id)
      .get()
      .go()
end

#validate_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse

Validates the provided JWT (encoded JWT string) to ensure the token is valid. A valid access token is properly signed and not expired. <p> This API may be used to verify the JWT as well as decode the encoded JWT into human readable identity claims.

Parameters:

  • encoded_jwt (string) —

    The encoded JWT (access token).

Returns:



3130
3131
3132
3133
3134
3135
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3130

def validate_jwt(encoded_jwt)
  startAnonymous.uri('/api/jwt/validate')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#verify_email(verification_id) ⇒ FusionAuth::ClientResponse

Confirms a email verification. The Id given is usually from an email sent to the user.

Parameters:

  • verification_id (string) —

    The email verification id sent to the user.

Returns:



3142
3143
3144
3145
3146
3147
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3142

def verify_email(verification_id)
  startAnonymous.uri('/api/user/verify-email')
      .url_segment(verification_id)
      .post()
      .go()
end

#verify_registration(verification_id) ⇒ FusionAuth::ClientResponse

Confirms an application registration. The Id given is usually from an email sent to the user.

Parameters:

  • verification_id (string) —

    The registration verification Id sent to the user.

Returns:



3154
3155
3156
3157
3158
3159
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3154

def verify_registration(verification_id)
  startAnonymous.uri('/api/user/verify-registration')
      .url_segment(verification_id)
      .post()
      .go()
end