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

#approve_device(client_id, client_secret, token, user_code) ⇒ FusionAuth::ClientResponse

Approve a device grant.

Parameters:

  • client_id (string) —

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

  • client_secret (string) —

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

  • token (string) —

    The access token used to identify the user.

  • user_code (string) —

    The end-user verification code.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/fusionauth/fusionauth_client.rb', line 92

def approve_device(client_id, client_secret, token, user_code)
  body = {
    "client_id" => client_id,
    "client_secret" => client_secret,
    "token" => token,
    "user_code" => user_code
  }
  start.uri('/oauth2/device/approve')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .post
      .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:



111
112
113
114
115
116
117
 
# File 'lib/fusionauth/fusionauth_client.rb', line 111

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 the information used to change the password.

Returns:



129
130
131
132
133
134
135
 
# File 'lib/fusionauth/fusionauth_client.rb', line 129

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 (loginId 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 the information used to change the password.

Returns:



144
145
146
147
148
149
 
# File 'lib/fusionauth/fusionauth_client.rb', line 144

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 Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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:



160
161
162
163
164
165
 
# File 'lib/fusionauth/fusionauth_client.rb', line 160

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 Trust Token by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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:



176
177
178
179
180
181
 
# File 'lib/fusionauth/fusionauth_client.rb', line 176

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 Trust Request Id by completing a Two-Factor Step-Up authentication.

An HTTP status code of 400 with a general error code of [TrustTokenRequired] 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:



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

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

#client_credentials_grant(client_id, client_secret, scope) ⇒ FusionAuth::ClientResponse

Make a Client Credentials grant request to obtain an access token.

Parameters:

  • client_id (string) —

    (Optional) The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate. This parameter is optional when Basic Authorization is used to authenticate this request.

  • client_secret (string) —

    (Optional) The client secret used to authenticate this request. This parameter is optional when Basic Authorization is used to authenticate this request.

  • scope (string) —

    (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:<target-entity-id>:<roles>. Roles are an optional comma separated list.

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/fusionauth/fusionauth_client.rb', line 208

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

#comment_on_user(request) ⇒ FusionAuth::ClientResponse

Adds a comment to the user’s account.

Parameters:

  • request (OpenStruct, Hash) —

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

Returns:



226
227
228
229
230
231
 
# File 'lib/fusionauth/fusionauth_client.rb', line 226

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

#complete_web_authn_assertion(request) ⇒ FusionAuth::ClientResponse

Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for completing the authentication ceremony

Returns:



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

def complete_web_authn_assertion(request)
  startAnonymous.uri('/api/webauthn/assert')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post
      .go
end

#complete_web_authn_login(request) ⇒ FusionAuth::ClientResponse

Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for completing the authentication ceremony

Returns:



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

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

#complete_web_authn_registration(request) ⇒ FusionAuth::ClientResponse

Complete a WebAuthn registration ceremony by validating the client request and saving the new credential

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for completing the registration ceremony

Returns:



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

def complete_web_authn_registration(request)
  start.uri('/api/webauthn/register/complete')
      .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 the information needed to create the APIKey.

Returns:



279
280
281
282
283
284
285
 
# File 'lib/fusionauth/fusionauth_client.rb', line 279

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:



293
294
295
296
297
298
299
 
# File 'lib/fusionauth/fusionauth_client.rb', line 293

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:



309
310
311
312
313
314
315
316
317
 
# File 'lib/fusionauth/fusionauth_client.rb', line 309

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:



326
327
328
329
330
331
 
# File 'lib/fusionauth/fusionauth_client.rb', line 326

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:



339
340
341
342
343
344
345
 
# File 'lib/fusionauth/fusionauth_client.rb', line 339

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:



353
354
355
356
357
358
359
 
# File 'lib/fusionauth/fusionauth_client.rb', line 353

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:



367
368
369
370
371
372
373
 
# File 'lib/fusionauth/fusionauth_client.rb', line 367

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:



381
382
383
384
385
386
387
 
# File 'lib/fusionauth/fusionauth_client.rb', line 381

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:



395
396
397
398
399
400
401
 
# File 'lib/fusionauth/fusionauth_client.rb', line 395

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:



411
412
413
414
415
416
417
418
419
 
# File 'lib/fusionauth/fusionauth_client.rb', line 411

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:



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

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:



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

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:



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

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:



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

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:



483
484
485
486
487
488
 
# File 'lib/fusionauth/fusionauth_client.rb', line 483

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:



510
511
512
513
514
515
516
 
# File 'lib/fusionauth/fusionauth_client.rb', line 510

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:



496
497
498
499
500
501
502
 
# File 'lib/fusionauth/fusionauth_client.rb', line 496

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:



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

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:



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

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:



552
553
554
555
556
557
558
 
# File 'lib/fusionauth/fusionauth_client.rb', line 552

def create_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post
      .go
end

#create_o_auth_scope(application_id, scope_id, request) ⇒ FusionAuth::ClientResponse

Creates a new custom OAuth scope for an application. You must specify the Id of the application you are creating the scope for. You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.

Parameters:

  • application_id (string) —

    The Id of the application to create the OAuth scope on.

  • scope_id (string) —

    (Optional) The Id of the OAuth scope. 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 OAuth OAuth scope.

Returns:



568
569
570
571
572
573
574
575
576
 
# File 'lib/fusionauth/fusionauth_client.rb', line 568

def create_o_auth_scope(application_id, scope_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("scope")
      .url_segment(scope_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:



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

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:



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

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:



612
613
614
615
616
617
618
 
# File 'lib/fusionauth/fusionauth_client.rb', line 612

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:



627
628
629
630
631
632
633
 
# File 'lib/fusionauth/fusionauth_client.rb', line 627

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:



642
643
644
645
646
647
648
 
# File 'lib/fusionauth/fusionauth_client.rb', line 642

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:



656
657
658
659
660
661
662
 
# File 'lib/fusionauth/fusionauth_client.rb', line 656

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:



669
670
671
672
673
674
 
# File 'lib/fusionauth/fusionauth_client.rb', line 669

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:



682
683
684
685
686
687
688
 
# File 'lib/fusionauth/fusionauth_client.rb', line 682

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:



695
696
697
698
699
700
 
# File 'lib/fusionauth/fusionauth_client.rb', line 695

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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 that the role belongs to.

  • role_id (string) —

    The Id of the role to delete.

Returns:



800
801
802
803
804
805
806
807
 
# File 'lib/fusionauth/fusionauth_client.rb', line 800

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:



814
815
816
817
818
819
 
# File 'lib/fusionauth/fusionauth_client.rb', line 814

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:



826
827
828
829
830
831
 
# File 'lib/fusionauth/fusionauth_client.rb', line 826

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:



838
839
840
841
842
843
 
# File 'lib/fusionauth/fusionauth_client.rb', line 838

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:



850
851
852
853
854
855
 
# File 'lib/fusionauth/fusionauth_client.rb', line 850

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:



864
865
866
867
868
869
870
871
872
 
# File 'lib/fusionauth/fusionauth_client.rb', line 864

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:



879
880
881
882
883
884
 
# File 'lib/fusionauth/fusionauth_client.rb', line 879

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:



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

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:



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

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:



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

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:



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

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

Returns:



943
944
945
946
947
948
 
# File 'lib/fusionauth/fusionauth_client.rb', line 943

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:



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

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:



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

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:



979
980
981
982
983
984
 
# File 'lib/fusionauth/fusionauth_client.rb', line 979

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:



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

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:



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

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:



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

def delete_messenger(messenger_id)
  start.uri('/api/messenger')
      .url_segment(messenger_id)
      .delete
      .go
end

#delete_o_auth_scope(application_id, scope_id) ⇒ FusionAuth::ClientResponse

Hard deletes a custom OAuth scope. OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the application’s unknown scope policy.

Parameters:

  • application_id (string) —

    The Id of the application that the OAuth scope belongs to.

  • scope_id (string) —

    The Id of the OAuth scope to delete.

Returns:



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

def delete_o_auth_scope(application_id, scope_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("scope")
      .url_segment(scope_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:



1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1044

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:



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

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:



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

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:



1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1087

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:



1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1102

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:



1115
1116
1117
1118
1119
1120
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1115

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:



1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1128

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:



1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1142

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:



1155
1156
1157
1158
1159
1160
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1155

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:



1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1169

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:



1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1185

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:



1203
1204
1205
1206
1207
1208
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1203

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:



1219
1220
1221
1222
1223
1224
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1219

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

#delete_web_authn_credential(id) ⇒ FusionAuth::ClientResponse

Deletes the WebAuthn credential for the given Id.

Parameters:

  • id (string) —

    The Id of the WebAuthn credential to delete.

Returns:



1231
1232
1233
1234
1235
1236
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1231

def delete_web_authn_credential(id)
  start.uri('/api/webauthn')
      .url_segment(id)
      .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:



1243
1244
1245
1246
1247
1248
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1243

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:



1257
1258
1259
1260
1261
1262
1263
1264
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1257

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:



1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1272

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:



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

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

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

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



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1304

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 are attempting to authenticate. This parameter is optional when the Authorization header is provided. This parameter is optional when Basic Authorization is used to authenticate this request.

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



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1329

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 are attempting to authenticate. This parameter is optional when the Authorization header is provided. This parameter is optional when Basic Authorization is used to authenticate this request.

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



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1355

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:



1375
1376
1377
1378
1379
1380
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1375

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 are attempting to authenticate. This parameter is optional when the Authorization header is provided. This parameter is optional when Basic Authorization is used to authenticate this request.

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



1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1394

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:



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

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:



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

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:



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

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:



1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1457

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:



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

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:



1484
1485
1486
1487
1488
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1484

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:



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

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:



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

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:



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

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 the information about all the refresh tokens to import.

Returns:



1544
1545
1546
1547
1548
1549
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1544

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 the information about all the users to import.

Returns:



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

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

#import_web_authn_credential(request) ⇒ FusionAuth::ClientResponse

Import a WebAuthn credential

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for importing the credential

Returns:



1575
1576
1577
1578
1579
1580
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1575

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

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

Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant.

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 client credentials grant.

Returns:



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

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

#introspect_client_credentials_access_token(token) ⇒ FusionAuth::ClientResponse

Inspect an access token issued as the result of the Client Credentials Grant.

Parameters:

  • token (string) —

    The access token returned by this OAuth provider as the result of a successful client credentials grant.

Returns:



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

def introspect_client_credentials_access_token(token)
  body = {
    "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:



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

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:



1643
1644
1645
1646
1647
1648
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1643

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:



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

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

#login_ping_with_request(request) ⇒ 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:

  • request (OpenStruct, Hash) —

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

Returns:



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

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



1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1695

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:



1709
1710
1711
1712
1713
1714
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1709

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:



1722
1723
1724
1725
1726
1727
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1722

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 the information about the modification.

Returns:



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

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 the information used to complete login.

Returns:



1749
1750
1751
1752
1753
1754
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1749

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 the information needed to create the APIKey.

Returns:



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

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:



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

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:



1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1791

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:



1807
1808
1809
1810
1811
1812
1813
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1807

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:



1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1821

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:



1835
1836
1837
1838
1839
1840
1841
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1835

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

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

Parameters:

  • entity_id (string) —

    The Id of the Entity Type to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new Entity information.

Returns:



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

def patch_entity(entity_id, request)
  start.uri('/api/entity')
      .url_segment(entity_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:



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

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

Patches 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 patch.

  • request (OpenStruct, Hash) —

    The request that contains the new permission information.

Returns:



1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1878

def patch_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))
      .patch
      .go
end

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

Patches the form with the given Id.

Parameters:

  • form_id (string) —

    The Id of the form to patch.

  • request (OpenStruct, Hash) —

    The request object that contains the new form information.

Returns:



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

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

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

Patches the form field with the given Id.

Parameters:

  • field_id (string) —

    The Id of the form field to patch.

  • request (OpenStruct, Hash) —

    The request object that contains the new form field information.

Returns:



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

def patch_form_field(field_id, request)
  start.uri('/api/form/field')
      .url_segment(field_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:



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

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:



1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/fusionauth/fusionauth_client.rb', line 1950

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:



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

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

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

Update the IP Access Control List with the given Id.

Parameters:

  • access_control_list_id (string) —

    The Id of the IP Access Control List to patch.

  • request (OpenStruct, Hash) —

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

Returns:



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

def patch_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))
      .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:



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

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:



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

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:



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

def patch_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .patch
      .go
end

#patch_o_auth_scope(application_id, scope_id, request) ⇒ FusionAuth::ClientResponse

Updates, via PATCH, the custom OAuth scope with the given Id for the application.

Parameters:

  • application_id (string) —

    The Id of the application that the OAuth scope belongs to.

  • scope_id (string) —

    The Id of the OAuth scope to update.

  • request (OpenStruct, Hash) —

    The request that contains just the new OAuth scope information.

Returns:



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

def patch_o_auth_scope(application_id, scope_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("scope")
      .url_segment(scope_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:



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

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:



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

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:



2061
2062
2063
2064
2065
2066
2067
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2061

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:



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

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:



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

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:



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

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:



2117
2118
2119
2120
2121
2122
2123
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2117

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:



2131
2132
2133
2134
2135
2136
2137
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2131

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

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

Patches the webhook with the given Id.

Parameters:

  • webhook_id (string) —

    The Id of the webhook to update.

  • request (OpenStruct, Hash) —

    The request that contains the new webhook information.

Returns:



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

def patch_webhook(webhook_id, request)
  start.uri('/api/webhook')
      .url_segment(webhook_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:



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

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:



2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2171

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:



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

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:



2197
2198
2199
2200
2201
2202
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2197

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:



2211
2212
2213
2214
2215
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2211

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:



2224
2225
2226
2227
2228
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2224

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:



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

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:



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

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:



2267
2268
2269
2270
2271
2272
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2267

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:



2280
2281
2282
2283
2284
2285
2286
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2280

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:



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

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:



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

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:



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

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:



2346
2347
2348
2349
2350
2351
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2346

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



2359
2360
2361
2362
2363
2364
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2359

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



2371
2372
2373
2374
2375
2376
2377
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2371

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



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

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:



2334
2335
2336
2337
2338
2339
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2334

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 the applications if the Id is null.

Parameters:

  • application_id (string) —

    (Optional) The application id.

Returns:



2398
2399
2400
2401
2402
2403
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2398

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

#retrieve_applications ⇒ FusionAuth::ClientResponse

Retrieves all the applications.

Returns:



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

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:



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

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:



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

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

#retrieve_connectors ⇒ FusionAuth::ClientResponse

Retrieves all the connectors.

Returns:



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

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:



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

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

#retrieve_consents ⇒ FusionAuth::ClientResponse

Retrieves all the consent.

Returns:



2465
2466
2467
2468
2469
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2465

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:



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

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 the email templates.

Parameters:

  • email_template_id (string) —

    (Optional) The Id of the email template.

Returns:



2493
2494
2495
2496
2497
2498
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2493

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:



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

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 the email templates.

Returns:



2518
2519
2520
2521
2522
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2518

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:



2529
2530
2531
2532
2533
2534
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2529

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:



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

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:



2558
2559
2560
2561
2562
2563
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2558

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 the Entity Types.

Returns:



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

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:



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

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 the families that a user belongs to.

Parameters:

  • user_id (string) —

    The User’s id

Returns:



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

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 the members of a family by the unique Family Id.

Parameters:

  • family_id (string) —

    The unique Id of the Family.

Returns:



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

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:



2616
2617
2618
2619
2620
2621
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2616

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:



2628
2629
2630
2631
2632
2633
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2628

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 the forms fields

Returns:



2639
2640
2641
2642
2643
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2639

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

#retrieve_forms ⇒ FusionAuth::ClientResponse

Retrieves all the forms.

Returns:



2649
2650
2651
2652
2653
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2649

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:



2660
2661
2662
2663
2664
2665
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2660

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

#retrieve_groups ⇒ FusionAuth::ClientResponse

Retrieves all the groups.

Returns:



2671
2672
2673
2674
2675
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2671

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 the identity providers if the Id is null.

Parameters:

  • identity_provider_id (string) —

    The identity provider Id.

Returns:



2694
2695
2696
2697
2698
2699
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2694

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 (string) —

    The type of the identity provider.

Returns:



2708
2709
2710
2711
2712
2713
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2708

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 the identity providers.

Returns:



2719
2720
2721
2722
2723
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2719

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

#retrieve_inactive_actions(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all 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:



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

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 the applications that are currently inactive.

Returns:



2743
2744
2745
2746
2747
2748
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2743

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

#retrieve_inactive_user_actions ⇒ FusionAuth::ClientResponse

Retrieves all the user actions that are currently inactive.

Returns:



2754
2755
2756
2757
2758
2759
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2754

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

#retrieve_integration ⇒ FusionAuth::ClientResponse

Retrieves the available integrations.

Returns:



2765
2766
2767
2768
2769
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2765

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:



2682
2683
2684
2685
2686
2687
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2682

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:



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

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:



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

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:



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

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:



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

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:



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

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

#retrieve_keys ⇒ FusionAuth::ClientResponse

Retrieves all the keys.

Returns:



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

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:



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

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

#retrieve_lambdas ⇒ FusionAuth::ClientResponse

Retrieves all the lambdas.

Returns:



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

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

#retrieve_lambdas_by_type(type) ⇒ FusionAuth::ClientResponse

Retrieves all the lambdas for the provided type.

Parameters:

  • type (string) —

    The type of the lambda to return.

Returns:



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

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:



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

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 the message templates.

Parameters:

  • message_template_id (string) —

    (Optional) The Id of the message template.

Returns:



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

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:



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

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 the message templates.

Returns:



2916
2917
2918
2919
2920
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2916

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:



2927
2928
2929
2930
2931
2932
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2927

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

#retrieve_messengers ⇒ FusionAuth::ClientResponse

Retrieves all the messengers.

Returns:



2938
2939
2940
2941
2942
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2938

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:



2952
2953
2954
2955
2956
2957
2958
2959
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2952

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_o_auth_scope(application_id, scope_id) ⇒ FusionAuth::ClientResponse

Retrieves a custom OAuth scope.

Parameters:

  • application_id (string) —

    The Id of the application that the OAuth scope belongs to.

  • scope_id (string) —

    The Id of the OAuth scope to retrieve.

Returns:



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

def retrieve_o_auth_scope(application_id, scope_id)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("scope")
      .url_segment(scope_id)
      .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:



2981
2982
2983
2984
2985
2986
2987
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2981

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:



2993
2994
2995
2996
2997
 
# File 'lib/fusionauth/fusionauth_client.rb', line 2993

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:



3006
3007
3008
3009
3010
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3006

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:



3019
3020
3021
3022
3023
3024
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3019

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 the children for the given parent email address.

Parameters:

  • parent_email (string) —

    The email of the parent.

Returns:



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

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

#retrieve_pending_link(pending_link_id, user_id) ⇒ FusionAuth::ClientResponse

Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.

Parameters:

  • p_ending_link_id (string) —

    The pending link Id.

  • user_id (string) —

    The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has.

Returns:



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

def retrieve_pending_link(pending_link_id, user_id)
  start.uri('/api/identity-provider/link/pending')
      .url_segment(pending_link_id)
      .url_parameter('userId', user_id)
      .get
      .go
end

#retrieve_reactor_metrics ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth Reactor metrics.

Returns:



3056
3057
3058
3059
3060
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3056

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

#retrieve_reactor_status ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth Reactor status.

Returns:



3066
3067
3068
3069
3070
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3066

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:



3078
3079
3080
3081
3082
3083
3084
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3078

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(token_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:

  • token_id (string) —

    The Id of the token.

Returns:



3091
3092
3093
3094
3095
3096
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3091

def retrieve_refresh_token_by_id(token_id)
  start.uri('/api/jwt/refresh')
      .url_segment(token_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:



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

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:



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

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:



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

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:



3146
3147
3148
3149
3150
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3146

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

#retrieve_system_configuration ⇒ FusionAuth::ClientResponse

Retrieves the system configuration.

Returns:



3156
3157
3158
3159
3160
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3156

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

#retrieve_system_health ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.

Returns:



3166
3167
3168
3169
3170
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3166

def retrieve_system_health
  startAnonymous.uri('/api/health')
      .get
      .go
end

#retrieve_system_status ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.

Returns:



3176
3177
3178
3179
3180
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3176

def retrieve_system_status
  startAnonymous.uri('/api/status')
      .get
      .go
end

#retrieve_system_status_using_api_key ⇒ FusionAuth::ClientResponse

Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.

Returns:



3186
3187
3188
3189
3190
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3186

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



3197
3198
3199
3200
3201
3202
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3197

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

#retrieve_tenants ⇒ FusionAuth::ClientResponse

Retrieves all the tenants.

Returns:



3208
3209
3210
3211
3212
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3208

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:



3219
3220
3221
3222
3223
3224
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3219

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

#retrieve_themes ⇒ FusionAuth::ClientResponse

Retrieves all the themes.

Returns:



3230
3231
3232
3233
3234
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3230

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

#retrieve_total_report ⇒ FusionAuth::ClientResponse

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

Returns:



3241
3242
3243
3244
3245
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3241

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:



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

def retrieve_two_factor_recovery_codes(user_id)
  start.uri('/api/user/two-factor/recovery-code')
      .url_segment(user_id)
      .get
      .go
end

#retrieve_two_factor_status(user_id, application_id, two_factor_trust_id) ⇒ FusionAuth::ClientResponse

Retrieve a user’s two-factor status.

This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications.

Parameters:

  • user_id (string) —

    The user Id to retrieve the Two-Factor status.

  • application_id (string) —

    The optional applicationId to verify.

  • two_factor_trust_id (string) —

    The optional two-factor trust Id to verify.

Returns:



3269
3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3269

def retrieve_two_factor_status(user_id, application_id, two_factor_trust_id)
  start.uri('/api/two-factor/status')
      .url_parameter('userId', user_id)
      .url_parameter('applicationId', application_id)
      .url_segment(two_factor_trust_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:



3283
3284
3285
3286
3287
3288
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3283

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 the user actions.

Parameters:

  • user_action_id (string) —

    (Optional) The Id of the user action.

Returns:



3296
3297
3298
3299
3300
3301
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3296

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 the user action reasons.

Parameters:

  • user_action_reason_id (string) —

    (Optional) The Id of the user action reason.

Returns:



3309
3310
3311
3312
3313
3314
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3309

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:



3320
3321
3322
3323
3324
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3320

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

#retrieve_user_actions ⇒ FusionAuth::ClientResponse

Retrieves all the user actions.

Returns:



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

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:



3342
3343
3344
3345
3346
3347
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3342

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:



3354
3355
3356
3357
3358
3359
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3354

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:



3366
3367
3368
3369
3370
3371
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3366

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:



3378
3379
3380
3381
3382
3383
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3378

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:



3391
3392
3393
3394
3395
3396
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3391

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

#retrieve_user_code(client_id, client_secret, user_code) ⇒ FusionAuth::ClientResponse

Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant.

Parameters:

  • client_id (string) —

    The client id.

  • client_secret (string) —

    The client id.

  • user_code (string) —

    The end-user verification code.

Returns:



3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3407

def retrieve_user_code(client_id, client_secret, user_code)
  body = {
    "client_id" => client_id,
    "client_secret" => client_secret,
    "user_code" => user_code
  }
  startAnonymous.uri('/oauth2/device/user-code')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .get
      .go
end

#retrieve_user_code_using_api_key(user_code) ⇒ FusionAuth::ClientResponse

Retrieve a user_code that is part of an in-progress Device Authorization Grant.

This API is useful if you want to build your own login workflow to complete a device grant.

This request will require an API key.

Parameters:

  • user_code (string) —

    The end-user verification code.

Returns:



3428
3429
3430
3431
3432
3433
3434
3435
3436
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3428

def retrieve_user_code_using_api_key(user_code)
  body = {
    "user_code" => user_code
  }
  startAnonymous.uri('/oauth2/device/user-code')
      .body_handler(FusionAuth::FormDataBodyHandler.new(body))
      .get
      .go
end

#retrieve_user_comments(user_id) ⇒ FusionAuth::ClientResponse

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

Parameters:

  • user_id (string) —

    The Id of the user.

Returns:



3443
3444
3445
3446
3447
3448
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3443

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:



3455
3456
3457
3458
3459
3460
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3455

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 the consents for a User.

Parameters:

  • user_id (string) —

    The User’s Id

Returns:



3467
3468
3469
3470
3471
3472
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3467

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:



3479
3480
3481
3482
3483
3484
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3479

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:



3493
3494
3495
3496
3497
3498
3499
3500
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3493

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:



3508
3509
3510
3511
3512
3513
3514
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3508

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:



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

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:



3544
3545
3546
3547
3548
3549
3550
3551
3552
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3544

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:



3561
3562
3563
3564
3565
3566
3567
3568
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3561

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:



3575
3576
3577
3578
3579
3580
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3575

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:



3586
3587
3588
3589
3590
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3586

def retrieve_version
  start.uri('/api/system/version')
      .get
      .go
end

#retrieve_web_authn_credential(id) ⇒ FusionAuth::ClientResponse

Retrieves the WebAuthn credential for the given Id.

Parameters:

  • id (string) —

    The Id of the WebAuthn credential.

Returns:



3597
3598
3599
3600
3601
3602
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3597

def retrieve_web_authn_credential(id)
  start.uri('/api/webauthn')
      .url_segment(id)
      .get
      .go
end

#retrieve_web_authn_credentials_for_user(user_id) ⇒ FusionAuth::ClientResponse

Retrieves all WebAuthn credentials for the given user.

Parameters:

  • user_id (string) —

    The user’s ID.

Returns:



3609
3610
3611
3612
3613
3614
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3609

def retrieve_web_authn_credentials_for_user(user_id)
  start.uri('/api/webauthn')
      .url_parameter('userId', user_id)
      .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:



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

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

#retrieve_webhook_attempt_log(webhook_attempt_log_id) ⇒ FusionAuth::ClientResponse

Retrieves a single webhook attempt log for the given Id.

Parameters:

  • webhook_attempt_log_id (string) —

    The Id of the webhook attempt log to retrieve.

Returns:



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

def retrieve_webhook_attempt_log(webhook_attempt_log_id)
  start.uri('/api/system/webhook-attempt-log')
      .url_segment(webhook_attempt_log_id)
      .get
      .go
end

#retrieve_webhook_event_log(webhook_event_log_id) ⇒ FusionAuth::ClientResponse

Retrieves a single webhook event log for the given Id.

Parameters:

  • webhook_event_log_id (string) —

    The Id of the webhook event log to retrieve.

Returns:



3645
3646
3647
3648
3649
3650
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3645

def retrieve_webhook_event_log(webhook_event_log_id)
  start.uri('/api/system/webhook-event-log')
      .url_segment(webhook_event_log_id)
      .get
      .go
end

#retrieve_webhooks ⇒ FusionAuth::ClientResponse

Retrieves all the webhooks.

Returns:



3656
3657
3658
3659
3660
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3656

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:



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

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:



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

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:



3718
3719
3720
3721
3722
3723
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3718

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:



3730
3731
3732
3733
3734
3735
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3730

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:



3742
3743
3744
3745
3746
3747
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3742

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:



3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3755

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:



3769
3770
3771
3772
3773
3774
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3769

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:



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

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

#search_applications(request) ⇒ FusionAuth::ClientResponse

Searches applications with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



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

def search_applications(request)
  start.uri('/api/application/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post
      .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:



3805
3806
3807
3808
3809
3810
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3805

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

#search_consents(request) ⇒ FusionAuth::ClientResponse

Searches consents with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3817
3818
3819
3820
3821
3822
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3817

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

#search_email_templates(request) ⇒ FusionAuth::ClientResponse

Searches email templates with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3829
3830
3831
3832
3833
3834
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3829

def search_email_templates(request)
  start.uri('/api/email/template/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:



3841
3842
3843
3844
3845
3846
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3841

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:



3853
3854
3855
3856
3857
3858
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3853

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:



3865
3866
3867
3868
3869
3870
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3865

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:



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

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:



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

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

#search_group_members(request) ⇒ FusionAuth::ClientResponse

Searches group members with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3901
3902
3903
3904
3905
3906
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3901

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

#search_groups(request) ⇒ FusionAuth::ClientResponse

Searches groups with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3913
3914
3915
3916
3917
3918
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3913

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

#search_identity_providers(request) ⇒ FusionAuth::ClientResponse

Searches identity providers with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3937
3938
3939
3940
3941
3942
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3937

def search_identity_providers(request)
  start.uri('/api/identity-provider/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:



3925
3926
3927
3928
3929
3930
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3925

def search_ip_access_control_lists(request)
  start.uri('/api/ip-acl/search')
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .post
      .go
end

#search_keys(request) ⇒ FusionAuth::ClientResponse

Searches keys with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3949
3950
3951
3952
3953
3954
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3949

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

#search_lambdas(request) ⇒ FusionAuth::ClientResponse

Searches lambdas with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3961
3962
3963
3964
3965
3966
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3961

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



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

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

#search_tenants(request) ⇒ FusionAuth::ClientResponse

Searches tenants with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



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

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

#search_themes(request) ⇒ FusionAuth::ClientResponse

Searches themes with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



3997
3998
3999
4000
4001
4002
 
# File 'lib/fusionauth/fusionauth_client.rb', line 3997

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

#search_user_comments(request) ⇒ FusionAuth::ClientResponse

Searches user comments with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



4009
4010
4011
4012
4013
4014
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4009

def search_user_comments(request)
  start.uri('/api/user/comment/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:



4022
4023
4024
4025
4026
4027
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4022

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:



4034
4035
4036
4037
4038
4039
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4034

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:



4047
4048
4049
4050
4051
4052
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4047

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:



4061
4062
4063
4064
4065
4066
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4061

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

#search_webhook_event_logs(request) ⇒ FusionAuth::ClientResponse

Searches the webhook event logs with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



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

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

#search_webhooks(request) ⇒ FusionAuth::ClientResponse

Searches webhooks with the specified criteria and pagination.

Parameters:

  • request (OpenStruct, Hash) —

    The search criteria and pagination information.

Returns:



4085
4086
4087
4088
4089
4090
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4085

def search_webhooks(request)
  start.uri('/api/webhook/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 the information used to send the email.

Returns:



4099
4100
4101
4102
4103
4104
4105
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4099

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:



4112
4113
4114
4115
4116
4117
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4112

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 the information used to send an email containing a code.

Returns:



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

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:



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

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:



4149
4150
4151
4152
4153
4154
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4149

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:



4162
4163
4164
4165
4166
4167
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4162

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

Returns:



4175
4176
4177
4178
4179
4180
4181
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4175

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:



4189
4190
4191
4192
4193
4194
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4189

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 the information used to begin the passwordless login request.

Returns:



4202
4203
4204
4205
4206
4207
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4202

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 a normal login that originated from the Login API (/api/login).

Parameters:

  • request (OpenStruct, Hash) —

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

Returns:



4219
4220
4221
4222
4223
4224
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4219

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

#start_web_authn_login(request) ⇒ FusionAuth::ClientResponse

Start a WebAuthn authentication ceremony by generating a new challenge for the user

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for starting the authentication ceremony

Returns:



4231
4232
4233
4234
4235
4236
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4231

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

#start_web_authn_registration(request) ⇒ FusionAuth::ClientResponse

Start a WebAuthn registration ceremony by generating a new challenge for the user

Parameters:

  • request (OpenStruct, Hash) —

    An object containing data necessary for starting the registration ceremony

Returns:



4243
4244
4245
4246
4247
4248
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4243

def start_web_authn_registration(request)
  start.uri('/api/webauthn/register/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:



4255
4256
4257
4258
4259
4260
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4255

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:



4268
4269
4270
4271
4272
4273
4274
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4268

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 the new application information.

Returns:



4282
4283
4284
4285
4286
4287
4288
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4282

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 the new role information.

Returns:



4297
4298
4299
4300
4301
4302
4303
4304
4305
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4297

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 the new connector information.

Returns:



4313
4314
4315
4316
4317
4318
4319
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4313

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 the new consent information.

Returns:



4327
4328
4329
4330
4331
4332
4333
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4327

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 the new email template information.

Returns:



4341
4342
4343
4344
4345
4346
4347
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4341

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 the new Entity information.

Returns:



4355
4356
4357
4358
4359
4360
4361
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4355

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 the new Entity Type information.

Returns:



4369
4370
4371
4372
4373
4374
4375
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4369

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 the new permission information.

Returns:



4384
4385
4386
4387
4388
4389
4390
4391
4392
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4384

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

Updates a family with a given Id.

Parameters:

  • family_id (string) —

    The Id of the family to update.

  • request (OpenStruct, Hash) —

    The request object that contains all the new family information.

Returns:



4400
4401
4402
4403
4404
4405
4406
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4400

def update_family(family_id, request)
  start.uri('/api/user/family')
      .url_segment(family_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 the new form information.

Returns:



4414
4415
4416
4417
4418
4419
4420
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4414

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 the new form field information.

Returns:



4428
4429
4430
4431
4432
4433
4434
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4428

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 the new group information.

Returns:



4442
4443
4444
4445
4446
4447
4448
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4442

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

#update_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:



4455
4456
4457
4458
4459
4460
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4455

def update_group_members(request)
  start.uri('/api/group/member')
      .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:



4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4482

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 the new integration information.

Returns:



4495
4496
4497
4498
4499
4500
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4495

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 the new IP Access Control List information.

Returns:



4468
4469
4470
4471
4472
4473
4474
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4468

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 the new key information.

Returns:



4508
4509
4510
4511
4512
4513
4514
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4508

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 the new lambda information.

Returns:



4522
4523
4524
4525
4526
4527
4528
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4522

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 the new message template information.

Returns:



4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4536

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 the new messenger information.

Returns:



4550
4551
4552
4553
4554
4555
4556
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4550

def update_messenger(messenger_id, request)
  start.uri('/api/messenger')
      .url_segment(messenger_id)
      .body_handler(FusionAuth::JSONBodyHandler.new(request))
      .put
      .go
end

#update_o_auth_scope(application_id, scope_id, request) ⇒ FusionAuth::ClientResponse

Updates the OAuth scope with the given Id for the application.

Parameters:

  • application_id (string) —

    The Id of the application that the OAuth scope belongs to.

  • scope_id (string) —

    The Id of the OAuth scope to update.

  • request (OpenStruct, Hash) —

    The request that contains all the new OAuth scope information.

Returns:



4565
4566
4567
4568
4569
4570
4571
4572
4573
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4565

def update_o_auth_scope(application_id, scope_id, request)
  start.uri('/api/application')
      .url_segment(application_id)
      .url_segment("scope")
      .url_segment(scope_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 the new registration information.

Returns:



4581
4582
4583
4584
4585
4586
4587
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4581

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 the new system configuration information.

Returns:



4594
4595
4596
4597
4598
4599
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4594

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 the new tenant information.

Returns:



4607
4608
4609
4610
4611
4612
4613
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4607

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 the new theme information.

Returns:



4621
4622
4623
4624
4625
4626
4627
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4621

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 the new user information.

Returns:



4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4635

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 the new user action information.

Returns:



4649
4650
4651
4652
4653
4654
4655
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4649

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 the new user action reason information.

Returns:



4663
4664
4665
4666
4667
4668
4669
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4663

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:



4677
4678
4679
4680
4681
4682
4683
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4677

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 the new webhook information.

Returns:



4691
4692
4693
4694
4695
4696
4697
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4691

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:



4705
4706
4707
4708
4709
4710
4711
4712
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4705

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:



4721
4722
4723
4724
4725
4726
4727
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4721

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:



4737
4738
4739
4740
4741
4742
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4737

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 the claims for this JWT.

Returns:



4757
4758
4759
4760
4761
4762
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4757

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:



4770
4771
4772
4773
4774
4775
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4770

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:



4787
4788
4789
4790
4791
4792
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4787

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

#verify_email_address_by_user_id(request) ⇒ FusionAuth::ClientResponse

Administratively verify a user’s email address. Use this method to bypass email verification for the user.

The request body will contain the userId to be verified. An API key is required when sending the userId in the request body.

Parameters:

  • request (OpenStruct, Hash) —

    The request that contains the userId to verify.

Returns:



4801
4802
4803
4804
4805
4806
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4801

def verify_email_address_by_user_id(request)
  start.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:



4814
4815
4816
4817
4818
4819
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4814

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:



4831
4832
4833
4834
4835
4836
 
# File 'lib/fusionauth/fusionauth_client.rb', line 4831

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