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

#activate_reactor(request) ⇒ FusionAuth::ClientResponse

Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)

Parameters:

  • request (OpenStruct, Hash) —

    An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).

Returns:



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

def activate_reactor(request)
  start.uri('/api/reactor')
      .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 the information used to determine which user to add to the family.

Returns:



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

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:



90
91
92
93
94
95
96
 
# File 'lib/fusionauth/fusionauth_client.rb', line 90

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.

As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set the value in the request body.

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:



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

def change_password(change_password_id, request)
  startAnonymous.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:



123
124
125
126
127
128
 
# File 'lib/fusionauth/fusionauth_client.rb', line 123

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

#check_change_password_using_id(change_password_id) ⇒ FusionAuth::ClientResponse

Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.

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.

Returns:



139
140
141
142
143
144
 
# File 'lib/fusionauth/fusionauth_client.rb', line 139

def check_change_password_using_id(change_password_id)
  startAnonymous.uri('/api/user/change-password')
      .url_segment(change_password_id)
      .get()
      .go()
end

#check_change_password_using_jwt(encoded_jwt) ⇒ FusionAuth::ClientResponse

Check to see if the user must obtain a Trust Token Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.

Parameters:

  • encoded_jwt (string) —

    The encoded JWT (access token).

Returns:



155
156
157
158
159
160
 
# File 'lib/fusionauth/fusionauth_client.rb', line 155

def check_change_password_using_jwt(encoded_jwt)
  startAnonymous.uri('/api/user/change-password')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#check_change_password_using_login_id(login_id) ⇒ FusionAuth::ClientResponse

Check to see if the user must obtain a Trust Request Id in order to complete a change password request. When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.

An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.

Parameters:

  • login_id (string) —

    The loginId of the User that you intend to change the password for.

Returns:



171
172
173
174
175
176
 
# File 'lib/fusionauth/fusionauth_client.rb', line 171

def ()
  start.uri('/api/user/change-password')
      .url_parameter('username', )
      .get()
      .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 the information used to create the user comment.

Returns:



183
184
185
186
187
188
 
# File 'lib/fusionauth/fusionauth_client.rb', line 183

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

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

Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated. an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted to that API key.

If an API key is locked to a tenant, it can only create API Keys for that same tenant.

Parameters:

  • key_id (string) —

    (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information needed to create the APIKey.

Returns:



200
201
202
203
204
205
206
 
# File 'lib/fusionauth/fusionauth_client.rb', line 200

def create_api_key(key_id, request)
  start.uri('/api/api-key')
      .url_segment(key_id)
      .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 the information used to create the application.

Returns:



214
215
216
217
218
219
220
 
# File 'lib/fusionauth/fusionauth_client.rb', line 214

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 the information used to create the application role.

Returns:



230
231
232
233
234
235
236
237
238
 
# File 'lib/fusionauth/fusionauth_client.rb', line 230

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 the information used to create the audit log entry.

Returns:



247
248
249
250
251
252
 
# File 'lib/fusionauth/fusionauth_client.rb', line 247

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 the information used to create the connector.

Returns:



260
261
262
263
264
265
266
 
# File 'lib/fusionauth/fusionauth_client.rb', line 260

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 the information used to create the consent.

Returns:



274
275
276
277
278
279
280
 
# File 'lib/fusionauth/fusionauth_client.rb', line 274

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 the information used to create the email template.

Returns:



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

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_entity(entity_id, request) ⇒ FusionAuth::ClientResponse

Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.

Parameters:

  • entity_id (string) —

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

  • request (OpenStruct, Hash) —

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

Returns:



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

def create_entity(entity_id, request)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • entity_type_id (string) —

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

  • request (OpenStruct, Hash) —

    The request object that contains all the information used to create the Entity Type.

Returns:



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

def create_entity_type(entity_type_id, request)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • entity_type_id (string) —

    The Id of the entity type to create the permission on.

  • permission_id (string) —

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

  • request (OpenStruct, Hash) —

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

Returns:



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

def create_entity_type_permission(entity_type_id, permission_id, request)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .url_segment("permission")
      .url_segment(permission_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 the information used to create the family.

Returns:



349
350
351
352
353
354
355
 
# File 'lib/fusionauth/fusionauth_client.rb', line 349

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 the information used to create the form.

Returns:



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

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 the information used to create the form field.

Returns:



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

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 the information used to create the group.

Returns:



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

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 the information used to create the group member(s).

Returns:



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

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 the information used to create the identity provider.

Returns:



431
432
433
434
435
436
437
 
# File 'lib/fusionauth/fusionauth_client.rb', line 431

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_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse

Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.

Parameters:

  • access_control_list_id (string) —

    (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all the information used to create the IP Access Control List.

Returns:



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

def create_ip_access_control_list(access_control_list_id, request)
  start.uri('/api/ip-acl')
      .url_segment(access_control_list_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 the information used to create the lambda.

Returns:



445
446
447
448
449
450
451
 
# File 'lib/fusionauth/fusionauth_client.rb', line 445

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

#create_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • message_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 the information used to create the message template.

Returns:



459
460
461
462
463
464
465
 
# File 'lib/fusionauth/fusionauth_client.rb', line 459

def create_message_template(message_template_id, request)
  start.uri('/api/message/template')
      .url_segment(message_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#create_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • messenger_id (string) —

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

  • request (OpenStruct, Hash) —

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

Returns:



473
474
475
476
477
478
479
 
# File 'lib/fusionauth/fusionauth_client.rb', line 473

def create_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_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 the information used to create the tenant.

Returns:



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

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 the information used to create the theme.

Returns:



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

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 the information used to create the user.

Returns:



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

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 the information used to create the user action.

Returns:



530
531
532
533
534
535
536
 
# File 'lib/fusionauth/fusionauth_client.rb', line 530

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 the information used to create the user action reason.

Returns:



545
546
547
548
549
550
551
 
# File 'lib/fusionauth/fusionauth_client.rb', line 545

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:



559
560
561
562
563
564
565
 
# File 'lib/fusionauth/fusionauth_client.rb', line 559

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_user_link(request) ⇒ FusionAuth::ClientResponse

Link an external user from a 3rd party identity provider to a FusionAuth user.

Parameters:

  • request (OpenStruct, Hash) —

    The request object that contains all the information used to link the FusionAuth user.

Returns:



572
573
574
575
576
577
 
# File 'lib/fusionauth/fusionauth_client.rb', line 572

def create_user_link(request)
  start.uri('/api/identity-provider/link')
      .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 the information used to create the webhook.

Returns:



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

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:



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

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

#deactivate_reactor ⇒ FusionAuth::ClientResponse

Deactivates the FusionAuth Reactor.

Returns:



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

def deactivate_reactor()
  start.uri('/api/reactor')
      .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:



620
621
622
623
624
625
 
# File 'lib/fusionauth/fusionauth_client.rb', line 620

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:



632
633
634
635
636
637
 
# File 'lib/fusionauth/fusionauth_client.rb', line 632

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:



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

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:



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

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_api_key(key_id) ⇒ FusionAuth::ClientResponse

Deletes the API key for the given Id.

Parameters:

  • key_id (string) —

    The Id of the authentication API key to delete.

Returns:



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

def delete_api_key(key_id)
  start.uri('/api/api-key')
      .url_segment(key_id)
      .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:



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

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:



703
704
705
706
707
708
709
710
 
# File 'lib/fusionauth/fusionauth_client.rb', line 703

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:



717
718
719
720
721
722
 
# File 'lib/fusionauth/fusionauth_client.rb', line 717

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:



729
730
731
732
733
734
 
# File 'lib/fusionauth/fusionauth_client.rb', line 729

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:



741
742
743
744
745
746
 
# File 'lib/fusionauth/fusionauth_client.rb', line 741

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

#delete_entity(entity_id) ⇒ FusionAuth::ClientResponse

Deletes the Entity for the given Id.

Parameters:

  • entity_id (string) —

    The Id of the Entity to delete.

Returns:



753
754
755
756
757
758
 
# File 'lib/fusionauth/fusionauth_client.rb', line 753

def delete_entity(entity_id)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .delete()
      .go()
end

#delete_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse

Deletes an Entity Grant for the given User or Entity.

Parameters:

  • entity_id (string) —

    The Id of the Entity that the Entity Grant is being deleted for.

  • recipient_entity_id (string) —

    (Optional) The Id of the Entity that the Entity Grant is for.

  • user_id (string) —

    (Optional) The Id of the User that the Entity Grant is for.

Returns:



767
768
769
770
771
772
773
774
775
 
# File 'lib/fusionauth/fusionauth_client.rb', line 767

def delete_entity_grant(entity_id, recipient_entity_id, user_id)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .url_segment("grant")
      .url_parameter('recipientEntityId', recipient_entity_id)
      .url_parameter('userId', user_id)
      .delete()
      .go()
end

#delete_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse

Deletes the Entity Type for the given Id.

Parameters:

  • entity_type_id (string) —

    The Id of the Entity Type to delete.

Returns:



782
783
784
785
786
787
 
# File 'lib/fusionauth/fusionauth_client.rb', line 782

def delete_entity_type(entity_type_id)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .delete()
      .go()
end

#delete_entity_type_permission(entity_type_id, permission_id) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • entity_type_id (string) —

    The Id of the entityType the the permission belongs to.

  • permission_id (string) —

    The Id of the permission to delete.

Returns:



796
797
798
799
800
801
802
803
 
# File 'lib/fusionauth/fusionauth_client.rb', line 796

def delete_entity_type_permission(entity_type_id, permission_id)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .url_segment("permission")
      .url_segment(permission_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:



810
811
812
813
814
815
 
# File 'lib/fusionauth/fusionauth_client.rb', line 810

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:



822
823
824
825
826
827
 
# File 'lib/fusionauth/fusionauth_client.rb', line 822

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:



834
835
836
837
838
839
 
# File 'lib/fusionauth/fusionauth_client.rb', line 834

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:



846
847
848
849
850
851
 
# File 'lib/fusionauth/fusionauth_client.rb', line 846

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:



870
871
872
873
874
875
 
# File 'lib/fusionauth/fusionauth_client.rb', line 870

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

#delete_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse

Deletes the IP Access Control List for the given Id.

Parameters:

  • ip_access_control_list_id (string) —

    The Id of the IP Access Control List to delete.

Returns:



858
859
860
861
862
863
 
# File 'lib/fusionauth/fusionauth_client.rb', line 858

def delete_ip_access_control_list(ip_access_control_list_id)
  start.uri('/api/ip-acl')
      .url_segment(ip_access_control_list_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:



882
883
884
885
886
887
 
# File 'lib/fusionauth/fusionauth_client.rb', line 882

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:



894
895
896
897
898
899
 
# File 'lib/fusionauth/fusionauth_client.rb', line 894

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

#delete_message_template(message_template_id) ⇒ FusionAuth::ClientResponse

Deletes the message template for the given Id.

Parameters:

  • message_template_id (string) —

    The Id of the message template to delete.

Returns:



906
907
908
909
910
911
 
# File 'lib/fusionauth/fusionauth_client.rb', line 906

def delete_message_template(message_template_id)
  start.uri('/api/message/template')
      .url_segment(message_template_id)
      .delete()
      .go()
end

#delete_messenger(messenger_id) ⇒ FusionAuth::ClientResponse

Deletes the messenger for the given Id.

Parameters:

  • messenger_id (string) —

    The Id of the messenger to delete.

Returns:



918
919
920
921
922
923
 
# File 'lib/fusionauth/fusionauth_client.rb', line 918

def delete_messenger(messenger_id)
  start.uri('/api/messenger')
      .url_segment(messenger_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:



931
932
933
934
935
936
937
 
# File 'lib/fusionauth/fusionauth_client.rb', line 931

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

#delete_registration_with_request(user_id, application_id, request) ⇒ FusionAuth::ClientResponse

Deletes the user registration for the given user and application along with the given JSON body that contains the event information.

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.

  • request (OpenStruct, Hash) —

    The request body that contains the event information.

Returns:



946
947
948
949
950
951
952
953
 
# File 'lib/fusionauth/fusionauth_client.rb', line 946

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

#delete_tenant(tenant_id) ⇒ FusionAuth::ClientResponse

Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc).

Parameters:

  • tenant_id (string) —

    The Id of the tenant to delete.

Returns:



961
962
963
964
965
966
 
# File 'lib/fusionauth/fusionauth_client.rb', line 961

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:



974
975
976
977
978
979
980
 
# File 'lib/fusionauth/fusionauth_client.rb', line 974

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

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

Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the tenant and everything under the tenant (applications, users, etc).

Parameters:

  • tenant_id (string) —

    The Id of the tenant to delete.

  • request (OpenStruct, Hash) —

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

Returns:



989
990
991
992
993
994
995
 
# File 'lib/fusionauth/fusionauth_client.rb', line 989

def delete_tenant_with_request(tenant_id, request)
  start.uri('/api/tenant')
      .url_segment(tenant_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



1002
1003
1004
1005
1006
1007
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1002

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:



1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1015

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:



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

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:



1042
1043
1044
1045
1046
1047
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1042

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_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse

Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.

Parameters:

  • identity_provider_id (string) —

    The unique Id of the identity provider.

  • identity_provider_user_id (string) —

    The unique Id of the user in the 3rd party identity provider to unlink.

  • user_id (string) —

    The unique Id of the FusionAuth user to unlink.

Returns:



1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1056

def delete_user_link(identity_provider_id, identity_provider_user_id, user_id)
  start.uri('/api/identity-provider/link')
      .url_parameter('identityProviderId', identity_provider_id)
      .url_parameter('identityProviderUserId', identity_provider_user_id)
      .url_parameter('userId', user_id)
      .delete()
      .go()
end

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

Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the user.

Parameters:

  • user_id (string) —

    The Id of the user to delete (required).

  • request (OpenStruct, Hash) —

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

Returns:



1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1072

def delete_user_with_request(user_id, request)
  start.uri('/api/user')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



1090
1091
1092
1093
1094
1095
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1090

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:



1106
1107
1108
1109
1110
1111
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1106

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:



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

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

#disable_two_factor(user_id, method_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.

  • method_id (string) —

    The two-factor method identifier you wish to disable

  • code (string) —

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

Returns:



1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1132

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

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

Disable Two Factor authentication for a user using a JSON body rather than URL parameters.

Parameters:

  • user_id (string) —

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

  • request (OpenStruct, Hash) —

    The request information that contains the code and methodId along with any event information.

Returns:



1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1147

def disable_two_factor_with_request(user_id, request)
  start.uri('/api/user/two-factor')
      .url_segment(user_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1161

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:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1178

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:



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

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:



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1227

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:



1247
1248
1249
1250
1251
1252
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1247

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:



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1265

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:



1286
1287
1288
1289
1290
1291
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1286

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:



1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1299

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 the information used to create the key.

Returns:



1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1313

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:



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

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_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse

Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes.

Parameters:

  • user_id (string) —

    The Id of the user to generate new Two Factor recovery codes.

Returns:



1342
1343
1344
1345
1346
1347
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1342

def generate_two_factor_recovery_codes(user_id)
  start.uri('/api/user/two-factor/recovery-code')
      .url_segment(user_id)
      .post()
      .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:



1355
1356
1357
1358
1359
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1355

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:



1368
1369
1370
1371
1372
1373
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1368

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:



1382
1383
1384
1385
1386
1387
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1382

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 the information used to create the key.

Returns:



1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1395

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:



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

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:



1434
1435
1436
1437
1438
1439
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1434

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:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1447

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:



1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1471

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:



1487
1488
1489
1490
1491
1492
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1487

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:



1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1505

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:



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

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

#logout_with_request(request) ⇒ 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 takes the refresh token in the JSON body.

Parameters:

  • request (OpenStruct, Hash) —

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

Returns:



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

def logout_with_request(request)
  startAnonymous.uri('/api/logout')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



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

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:



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

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:



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

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

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

Updates an authentication API key by given id

Parameters:

  • key_id (string) —

    The Id of the authentication key. If not provided a secure random api key will be generated.

  • request (OpenStruct, Hash) —

    The request object that contains all of the information needed to create the APIKey.

Returns:



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

def patch_api_key(key_id, request)
  start.uri('/api/api-key')
      .url_segment(key_id)
      .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:



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

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:



1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1620

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:



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

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:



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

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:



1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1664

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_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the Entity Type with the given Id.

Parameters:

  • entity_type_id (string) —

    The Id of the Entity Type to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new Entity Type information.

Returns:



1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1678

def patch_entity_type(entity_type_id, request)
  start.uri('/api/entity/type')
      .url_segment(entity_type_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:



1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1692

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:



1706
1707
1708
1709
1710
1711
1712
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1706

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:



1719
1720
1721
1722
1723
1724
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1719

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:



1732
1733
1734
1735
1736
1737
1738
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1732

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

#patch_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • message_template_id (string) —

    The Id of the message template to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new message template information.

Returns:



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

def patch_message_template(message_template_id, request)
  start.uri('/api/message/template')
      .url_segment(message_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch()
      .go()
end

#patch_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • messenger_id (string) —

    The Id of the messenger to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new messenger information.

Returns:



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

def patch_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_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:



1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1774

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:



1787
1788
1789
1790
1791
1792
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1787

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:



1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1800

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:



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

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:



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

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:



1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1842

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:



1856
1857
1858
1859
1860
1861
1862
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1856

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:



1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1870

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:



1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1883

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:



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

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:



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

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:



1922
1923
1924
1925
1926
1927
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1922

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

#refresh_entity_search_index ⇒ FusionAuth::ClientResponse

Request a refresh of the Entity 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 Entity 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:



1936
1937
1938
1939
1940
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1936

def refresh_entity_search_index()
  start.uri('/api/entity/search')
      .put()
      .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:



1949
1950
1951
1952
1953
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1949

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

#regenerate_reactor_keys ⇒ FusionAuth::ClientResponse

Regenerates any keys that are used by the FusionAuth Reactor.

Returns:



1959
1960
1961
1962
1963
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1959

def regenerate_reactor_keys()
  start.uri('/api/reactor')
      .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:



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

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

#reindex(request) ⇒ FusionAuth::ClientResponse

Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index.

You have been warned.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the index name.

Returns:



1992
1993
1994
1995
1996
1997
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1992

def reindex(request)
  start.uri('/api/system/reindex')
      .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:



2005
2006
2007
2008
2009
2010
2011
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2005

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:



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

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:



2032
2033
2034
2035
2036
2037
2038
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2032

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:



2046
2047
2048
2049
2050
2051
2052
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2046

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:



2071
2072
2073
2074
2075
2076
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2071

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:



2084
2085
2086
2087
2088
2089
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2084

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:



2096
2097
2098
2099
2100
2101
2102
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2096

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:



2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2110

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

#retrieve_api_key(key_id) ⇒ FusionAuth::ClientResponse

Retrieves an authentication API key for the given id

Parameters:

  • key_id (string) —

    The Id of the API key to retrieve.

Returns:



2059
2060
2061
2062
2063
2064
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2059

def retrieve_api_key(key_id)
  start.uri('/api/api-key')
      .url_segment(key_id)
      .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:



2123
2124
2125
2126
2127
2128
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2123

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:



2134
2135
2136
2137
2138
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2134

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:



2145
2146
2147
2148
2149
2150
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2145

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:



2157
2158
2159
2160
2161
2162
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2157

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:



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

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:



2179
2180
2181
2182
2183
2184
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2179

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:



2190
2191
2192
2193
2194
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2190

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:



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

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:



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

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:



2232
2233
2234
2235
2236
2237
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2232

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:



2243
2244
2245
2246
2247
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2243

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

#retrieve_entity(entity_id) ⇒ FusionAuth::ClientResponse

Retrieves the Entity for the given Id.

Parameters:

  • entity_id (string) —

    The Id of the Entity.

Returns:



2254
2255
2256
2257
2258
2259
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2254

def retrieve_entity(entity_id)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .get()
      .go()
end

#retrieve_entity_grant(entity_id, recipient_entity_id, user_id) ⇒ FusionAuth::ClientResponse

Retrieves an Entity Grant for the given Entity and User/Entity.

Parameters:

  • entity_id (string) —

    The Id of the Entity.

  • recipient_entity_id (string) —

    (Optional) The Id of the Entity that the Entity Grant is for.

  • user_id (string) —

    (Optional) The Id of the User that the Entity Grant is for.

Returns:



2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2268

def retrieve_entity_grant(entity_id, recipient_entity_id, user_id)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .url_segment("grant")
      .url_parameter('recipientEntityId', recipient_entity_id)
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_entity_type(entity_type_id) ⇒ FusionAuth::ClientResponse

Retrieves the Entity Type for the given Id.

Parameters:

  • entity_type_id (string) —

    The Id of the Entity Type.

Returns:



2283
2284
2285
2286
2287
2288
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2283

def retrieve_entity_type(entity_type_id)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .get()
      .go()
end

#retrieve_entity_types ⇒ FusionAuth::ClientResponse

Retrieves all of the Entity Types.

Returns:



2294
2295
2296
2297
2298
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2294

def retrieve_entity_types()
  start.uri('/api/entity/type')
      .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:



2305
2306
2307
2308
2309
2310
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2305

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:



2317
2318
2319
2320
2321
2322
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2317

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:



2329
2330
2331
2332
2333
2334
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2329

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:



2341
2342
2343
2344
2345
2346
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2341

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:



2353
2354
2355
2356
2357
2358
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2353

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:



2364
2365
2366
2367
2368
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2364

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

#retrieve_forms ⇒ FusionAuth::ClientResponse

Retrieves all of the forms.

Returns:



2374
2375
2376
2377
2378
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2374

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:



2385
2386
2387
2388
2389
2390
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2385

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:



2396
2397
2398
2399
2400
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2396

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:



2419
2420
2421
2422
2423
2424
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2419

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:



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

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:



2444
2445
2446
2447
2448
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2444

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:



2456
2457
2458
2459
2460
2461
2462
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2456

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:



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

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:



2479
2480
2481
2482
2483
2484
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2479

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

#retrieve_integration ⇒ FusionAuth::ClientResponse

Retrieves the available integrations.

Returns:



2490
2491
2492
2493
2494
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2490

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

#retrieve_ip_access_control_list(ip_access_control_list_id) ⇒ FusionAuth::ClientResponse

Retrieves the IP Access Control List with the given Id.

Parameters:

  • ip_access_control_list_id (string) —

    The Id of the IP Access Control List.

Returns:



2407
2408
2409
2410
2411
2412
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2407

def retrieve_ip_access_control_list(ip_access_control_list_id)
  start.uri('/api/ip-acl')
      .url_segment(ip_access_control_list_id)
      .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:



2534
2535
2536
2537
2538
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2534

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:



2501
2502
2503
2504
2505
2506
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2501

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:



2513
2514
2515
2516
2517
2518
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2513

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:



2524
2525
2526
2527
2528
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2524

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:



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

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:



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

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:



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

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:



2578
2579
2580
2581
2582
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2578

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:



2589
2590
2591
2592
2593
2594
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2589

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:



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

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_message_template(message_template_id) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • message_template_id (string) —

    (Optional) The Id of the message template.

Returns:



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

def retrieve_message_template(message_template_id)
  start.uri('/api/message/template')
      .url_segment(message_template_id)
      .get()
      .go()
end

#retrieve_message_template_preview(request) ⇒ FusionAuth::ClientResponse

Creates a preview of the message template provided in the request, normalized to a given locale.

Parameters:

  • request (OpenStruct, Hash) —

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

Returns:



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

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

#retrieve_message_templates ⇒ FusionAuth::ClientResponse

Retrieves all of the message templates.

Returns:



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

def retrieve_message_templates()
  start.uri('/api/message/template')
      .get()
      .go()
end

#retrieve_messenger(messenger_id) ⇒ FusionAuth::ClientResponse

Retrieves the messenger with the given Id.

Parameters:

  • messenger_id (string) —

    The Id of the messenger.

Returns:



2652
2653
2654
2655
2656
2657
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2652

def retrieve_messenger(messenger_id)
  start.uri('/api/messenger')
      .url_segment(messenger_id)
      .get()
      .go()
end

#retrieve_messengers ⇒ FusionAuth::ClientResponse

Retrieves all of the messengers.

Returns:



2663
2664
2665
2666
2667
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2663

def retrieve_messengers()
  start.uri('/api/messenger')
      .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:



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

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:



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

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:



2703
2704
2705
2706
2707
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2703

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:



2716
2717
2718
2719
2720
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2716

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:



2729
2730
2731
2732
2733
2734
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2729

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:



2741
2742
2743
2744
2745
2746
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2741

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

#retrieve_reactor_metrics ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth Reactor metrics.

Returns:



2752
2753
2754
2755
2756
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2752

def retrieve_reactor_metrics()
  start.uri('/api/reactor/metrics')
      .get()
      .go()
end

#retrieve_reactor_status ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth Reactor status.

Returns:



2762
2763
2764
2765
2766
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2762

def retrieve_reactor_status()
  start.uri('/api/reactor')
      .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:



2774
2775
2776
2777
2778
2779
2780
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2774

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:



2787
2788
2789
2790
2791
2792
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2787

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:



2799
2800
2801
2802
2803
2804
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2799

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:



2812
2813
2814
2815
2816
2817
2818
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2812

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:



2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2828

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_reindex_status ⇒ FusionAuth::ClientResponse

Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of

404 indicates no re-index is in progress.

Returns:



2842
2843
2844
2845
2846
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2842

def retrieve_reindex_status()
  start.uri('/api/system/reindex')
      .get()
      .go()
end

#retrieve_system_configuration ⇒ FusionAuth::ClientResponse

Retrieves the system configuration.

Returns:



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

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:



2863
2864
2865
2866
2867
2868
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2863

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:



2874
2875
2876
2877
2878
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2874

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:



2885
2886
2887
2888
2889
2890
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2885

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:



2896
2897
2898
2899
2900
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2896

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:



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

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

#retrieve_two_factor_recovery_codes(user_id) ⇒ FusionAuth::ClientResponse

Retrieve two-factor recovery codes for a user.

Parameters:

  • user_id (string) —

    The Id of the user to retrieve Two Factor recovery codes.

Returns:



2918
2919
2920
2921
2922
2923
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2918

def retrieve_two_factor_recovery_codes(user_id)
  start.uri('/api/user/two-factor/recovery-code')
      .url_segment(user_id)
      .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:



2930
2931
2932
2933
2934
2935
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2930

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:



2943
2944
2945
2946
2947
2948
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2943

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:



2956
2957
2958
2959
2960
2961
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2956

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:



2967
2968
2969
2970
2971
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2967

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:



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

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:



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

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:



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

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:



3013
3014
3015
3016
3017
3018
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3013

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:



3025
3026
3027
3028
3029
3030
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3025

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:



3038
3039
3040
3041
3042
3043
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3038

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:



3050
3051
3052
3053
3054
3055
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3050

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:



3062
3063
3064
3065
3066
3067
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3062

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:



3074
3075
3076
3077
3078
3079
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3074

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:



3086
3087
3088
3089
3090
3091
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3086

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

#retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id) ⇒ FusionAuth::ClientResponse

Retrieve a single Identity Provider user (link).

Parameters:

  • identity_provider_id (string) —

    The unique Id of the identity provider.

  • identity_provider_user_id (string) —

    The unique Id of the user in the 3rd party identity provider.

  • user_id (string) —

    The unique Id of the FusionAuth user.

Returns:



3100
3101
3102
3103
3104
3105
3106
3107
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3100

def retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id)
  start.uri('/api/identity-provider/link')
      .url_parameter('identityProviderId', identity_provider_id)
      .url_parameter('identityProviderUserId', identity_provider_user_id)
      .url_parameter('userId', user_id)
      .get()
      .go()
end

#retrieve_user_links_by_user_id(identity_provider_id, user_id) ⇒ FusionAuth::ClientResponse

Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.

Parameters:

  • identity_provider_id (string) —

    (Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.

  • user_id (string) —

    The unique Id of the user.

Returns:



3115
3116
3117
3118
3119
3120
3121
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3115

def retrieve_user_links_by_user_id(identity_provider_id, user_id)
  start.uri('/api/identity-provider/link')
      .url_parameter('identityProviderId', identity_provider_id)
      .url_parameter('userId', user_id)
      .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:



3132
3133
3134
3135
3136
3137
3138
3139
3140
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3132

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:



3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3151

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:



3168
3169
3170
3171
3172
3173
3174
3175
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3168

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:



3182
3183
3184
3185
3186
3187
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3182

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

#retrieve_version ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth version string.

Returns:



3193
3194
3195
3196
3197
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3193

def retrieve_version()
  start.uri('/api/system/version')
      .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:



3204
3205
3206
3207
3208
3209
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3204

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:



3215
3216
3217
3218
3219
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3215

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:



3251
3252
3253
3254
3255
3256
3257
3258
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3251

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:



3265
3266
3267
3268
3269
3270
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3265

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:



3277
3278
3279
3280
3281
3282
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3277

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:



3289
3290
3291
3292
3293
3294
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3289

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:



3301
3302
3303
3304
3305
3306
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3301

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:



3314
3315
3316
3317
3318
3319
3320
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3314

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_refresh_tokens_with_request(request) ⇒ FusionAuth::ClientResponse

Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information.

Parameters:

  • request (OpenStruct, Hash) —

    The request information used to revoke the refresh tokens.

Returns:



3328
3329
3330
3331
3332
3333
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3328

def revoke_refresh_tokens_with_request(request)
  start.uri('/api/jwt/refresh')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



3340
3341
3342
3343
3344
3345
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3340

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:



3352
3353
3354
3355
3356
3357
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3352

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

#search_entities(request) ⇒ FusionAuth::ClientResponse

Searches entities with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3364
3365
3366
3367
3368
3369
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3364

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

#search_entities_by_ids(ids) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • ids (Array) —

    The entity ids to search for.

Returns:



3376
3377
3378
3379
3380
3381
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3376

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

#search_entity_grants(request) ⇒ FusionAuth::ClientResponse

Searches Entity Grants with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3388
3389
3390
3391
3392
3393
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3388

def search_entity_grants(request)
  start.uri('/api/entity/grant/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#search_entity_types(request) ⇒ FusionAuth::ClientResponse

Searches the entity types with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3400
3401
3402
3403
3404
3405
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3400

def search_entity_types(request)
  start.uri('/api/entity/type/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:



3412
3413
3414
3415
3416
3417
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3412

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

#search_ip_access_control_lists(request) ⇒ FusionAuth::ClientResponse

Searches the IP Access Control Lists with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3424
3425
3426
3427
3428
3429
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3424

def search_ip_access_control_lists(request)
  start.uri('/api/ip-acl/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:



3436
3437
3438
3439
3440
3441
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3436

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:



3449
3450
3451
3452
3453
3454
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3449

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:



3461
3462
3463
3464
3465
3466
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3461

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:



3474
3475
3476
3477
3478
3479
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3474

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:



3488
3489
3490
3491
3492
3493
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3488

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:



3502
3503
3504
3505
3506
3507
3508
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3502

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:



3515
3516
3517
3518
3519
3520
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3515

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:



3527
3528
3529
3530
3531
3532
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3527

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

Deprecated.

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

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 the information used to send the code.

Returns:



3540
3541
3542
3543
3544
3545
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3540

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_enable_disable(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 the information used to send the code.

Returns:



3552
3553
3554
3555
3556
3557
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3552

def send_two_factor_code_for_enable_disable(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

Deprecated.

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

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:



3565
3566
3567
3568
3569
3570
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3565

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

#send_two_factor_code_for_login_using_method(two_factor_id, request) ⇒ 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.

  • request (OpenStruct, Hash) —

    The Two Factor send request that contains all of the information used to send the Two Factor code to the user.

Returns:



3578
3579
3580
3581
3582
3583
3584
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3578

def (two_factor_id, request)
  startAnonymous.uri('/api/two-factor/send')
      .url_segment(two_factor_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .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:



3592
3593
3594
3595
3596
3597
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3592

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:



3605
3606
3607
3608
3609
3610
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3605

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

#start_two_factor_login(request) ⇒ FusionAuth::ClientResponse

Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code.

This API is intended to allow you to begin a Two-Factor login outside of a normal login that originated from the Login API (/api/login).

Parameters:

  • request (OpenStruct, Hash) —

    The Two-Factor start request that contains all of the information used to begin the Two-Factor login request.

Returns:



3622
3623
3624
3625
3626
3627
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3622

def (request)
  start.uri('/api/two-factor/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:



3634
3635
3636
3637
3638
3639
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3634

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

#update_api_key(api_key_id, request) ⇒ FusionAuth::ClientResponse

Updates an API key by given id

Parameters:

  • api_key_id (string) —

    The Id of the API key to update.

  • request (OpenStruct, Hash) —

    The request object that contains all the information used to create the API Key.

Returns:



3647
3648
3649
3650
3651
3652
3653
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3647

def update_api_key(api_key_id, request)
  start.uri('/api/api-key')
      .url_segment(api_key_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .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:



3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3661

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:



3676
3677
3678
3679
3680
3681
3682
3683
3684
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3676

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:



3692
3693
3694
3695
3696
3697
3698
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3692

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:



3706
3707
3708
3709
3710
3711
3712
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3706

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:



3720
3721
3722
3723
3724
3725
3726
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3720

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_entity(entity_id, request) ⇒ FusionAuth::ClientResponse

Updates the Entity with the given Id.

Parameters:

  • entity_id (string) —

    The Id of the Entity to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new Entity information.

Returns:



3734
3735
3736
3737
3738
3739
3740
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3734

def update_entity(entity_id, request)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_entity_type(entity_type_id, request) ⇒ FusionAuth::ClientResponse

Updates the Entity Type with the given Id.

Parameters:

  • entity_type_id (string) —

    The Id of the Entity Type to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new Entity Type information.

Returns:



3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3748

def update_entity_type(entity_type_id, request)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_entity_type_permission(entity_type_id, permission_id, request) ⇒ FusionAuth::ClientResponse

Updates the permission with the given id for the entity type.

Parameters:

  • entity_type_id (string) —

    The Id of the entityType that the permission belongs to.

  • permission_id (string) —

    The Id of the permission to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new permission information.

Returns:



3763
3764
3765
3766
3767
3768
3769
3770
3771
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3763

def update_entity_type_permission(entity_type_id, permission_id, request)
  start.uri('/api/entity/type')
      .url_segment(entity_type_id)
      .url_segment("permission")
      .url_segment(permission_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:



3779
3780
3781
3782
3783
3784
3785
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3779

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:



3793
3794
3795
3796
3797
3798
3799
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3793

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:



3807
3808
3809
3810
3811
3812
3813
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3807

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:



3835
3836
3837
3838
3839
3840
3841
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3835

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:



3848
3849
3850
3851
3852
3853
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3848

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

#update_ip_access_control_list(access_control_list_id, request) ⇒ FusionAuth::ClientResponse

Updates the IP Access Control List with the given Id.

Parameters:

  • access_control_list_id (string) —

    The Id of the IP Access Control List to update.

  • request (OpenStruct, Hash) —

    The request that contains all of the new IP Access Control List information.

Returns:



3821
3822
3823
3824
3825
3826
3827
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3821

def update_ip_access_control_list(access_control_list_id, request)
  start.uri('/api/ip-acl')
      .url_segment(access_control_list_id)
      .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:



3861
3862
3863
3864
3865
3866
3867
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3861

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:



3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3875

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

#update_message_template(message_template_id, request) ⇒ FusionAuth::ClientResponse

Updates the message template with the given Id.

Parameters:

  • message_template_id (string) —

    The Id of the message template to update.

  • request (OpenStruct, Hash) —

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

Returns:



3889
3890
3891
3892
3893
3894
3895
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3889

def update_message_template(message_template_id, request)
  start.uri('/api/message/template')
      .url_segment(message_template_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put()
      .go()
end

#update_messenger(messenger_id, request) ⇒ FusionAuth::ClientResponse

Updates the messenger with the given Id.

Parameters:

  • messenger_id (string) —

    The Id of the messenger to update.

  • request (OpenStruct, Hash) —

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

Returns:



3903
3904
3905
3906
3907
3908
3909
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3903

def update_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_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:



3917
3918
3919
3920
3921
3922
3923
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3917

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:



3930
3931
3932
3933
3934
3935
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3930

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:



3943
3944
3945
3946
3947
3948
3949
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3943

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:



3957
3958
3959
3960
3961
3962
3963
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3957

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:



3971
3972
3973
3974
3975
3976
3977
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3971

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:



3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3985

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:



3999
4000
4001
4002
4003
4004
4005
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3999

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:



4013
4014
4015
4016
4017
4018
4019
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4013

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:



4027
4028
4029
4030
4031
4032
4033
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4027

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

#upsert_entity_grant(entity_id, request) ⇒ FusionAuth::ClientResponse

Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.

Parameters:

  • entity_id (string) —

    The Id of the Entity that the User/Entity is being granted access to.

  • request (OpenStruct, Hash) —

    The request object that contains all the information used to create the Entity Grant.

Returns:



4041
4042
4043
4044
4045
4046
4047
4048
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4041

def upsert_entity_grant(entity_id, request)
  start.uri('/api/entity')
      .url_segment(entity_id)
      .url_segment("grant")
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .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:



4057
4058
4059
4060
4061
4062
4063
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4057

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:



4073
4074
4075
4076
4077
4078
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4073

def validate_jwt(encoded_jwt)
  startAnonymous.uri('/api/jwt/validate')
      .authorization('Bearer ' + encoded_jwt)
      .get()
      .go()
end

#vend_jwt(request) ⇒ FusionAuth::ClientResponse

It’s a JWT vending machine!

Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form token that will contain what claims you provide. <p> The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.

If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains all of the claims for this JWT.

Returns:



4093
4094
4095
4096
4097
4098
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4093

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

#verify_email(verification_id) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to verify_email_address and changed to take a JSON request body, use that method instead.

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:



4106
4107
4108
4109
4110
4111
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4106

def verify_email(verification_id)
  startAnonymous.uri('/api/user/verify-email')
      .url_segment(verification_id)
      .post()
      .go()
end

#verify_email_address(request) ⇒ FusionAuth::ClientResponse

Confirms a user’s email address.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user’s email address and mark the user’s email address as verified.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the verificationId and optional one-time use code paired with the verificationId.

Returns:



4123
4124
4125
4126
4127
4128
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4123

def verify_email_address(request)
  startAnonymous.uri('/api/user/verify-email')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end

#verify_registration(verification_id) ⇒ FusionAuth::ClientResponse

Deprecated.

This method has been renamed to verify_user_registration and changed to take a JSON request body, use that method instead.

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:



4136
4137
4138
4139
4140
4141
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4136

def verify_registration(verification_id)
  startAnonymous.uri('/api/user/verify-registration')
      .url_segment(verification_id)
      .post()
      .go()
end

#verify_user_registration(request) ⇒ FusionAuth::ClientResponse

Confirms a user’s registration.

The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user’s registration and mark the user’s registration as verified.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the verificationId and optional one-time use code paired with the verificationId.

Returns:



4153
4154
4155
4156
4157
4158
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4153

def verify_user_registration(request)
  startAnonymous.uri('/api/user/verify-registration')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post()
      .go()
end