fusionauth_client 1.12.1 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +8 -0
- data/build.savant +1 -1
- data/fusionauth_client.gemspec +1 -1
- data/lib/fusionauth/fusionauth_client.rb +68 -200
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 20e4f6f09a02f6f07a166d2fe793904849a8ceaab9e3681b465d239f1853a98d
|
4
|
+
data.tar.gz: d76a9b178b3b202304313106e7eefa749367d81efe51752adf50d813c053c127
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 84d9764b12a5e92cb6758432f7e85b21997a66f819a31ac9fe439466292c14d8eebcf650ff13c5d7be978e2427d96a762d4aa923c0e43048fc6b26004100854d
|
7
|
+
data.tar.gz: e81327c19c19f438bb3731a2727aeccf09ccb449e440222d3568ca086f6029a77112480a11c659523695195d92b2cecaea257948bc556fcdd6e8440edae40a90
|
data/README.md
CHANGED
@@ -23,6 +23,14 @@ Or install it yourself as:
|
|
23
23
|
Once the gem is installed, you can call FusionAuth APIs like this:
|
24
24
|
|
25
25
|
```ruby
|
26
|
+
require 'fusionauth/fusionauth_client'
|
27
|
+
|
28
|
+
# Construct the FusionAuth Client
|
29
|
+
client = FusionAuth::FusionAuthClient.new(
|
30
|
+
'<YOUR_API_KEY>',
|
31
|
+
'http://localhost:9011'
|
32
|
+
)
|
33
|
+
|
26
34
|
# Create a user + registration
|
27
35
|
id = SecureRandom.uuid
|
28
36
|
client.register!(id, {
|
data/build.savant
CHANGED
@@ -16,7 +16,7 @@
|
|
16
16
|
savantVersion = "1.0.0"
|
17
17
|
|
18
18
|
pubVersion = ""
|
19
|
-
project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.
|
19
|
+
project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.13.0", licenses: ["ApacheV2_0"]) {
|
20
20
|
workflow {
|
21
21
|
standard()
|
22
22
|
}
|
data/fusionauth_client.gemspec
CHANGED
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
4
4
|
|
5
5
|
Gem::Specification.new do |spec|
|
6
6
|
spec.name = 'fusionauth_client'
|
7
|
-
spec.version = '1.
|
7
|
+
spec.version = '1.13.0'
|
8
8
|
spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
|
9
9
|
spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
|
10
10
|
|
@@ -50,7 +50,6 @@ module FusionAuth
|
|
50
50
|
# @param request [OpenStruct, Hash] The action request that includes all of the information about the action being taken including
|
51
51
|
# the id of the action, any options and the duration (if applicable).
|
52
52
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
53
|
-
#
|
54
53
|
def action_user(actionee_user_id, request)
|
55
54
|
start.uri('/api/user/action')
|
56
55
|
.url_segment(actionee_user_id)
|
@@ -65,7 +64,6 @@ module FusionAuth
|
|
65
64
|
# @param family_id [string] The id of the family.
|
66
65
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to determine which user to add to the family.
|
67
66
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
68
|
-
#
|
69
67
|
def add_user_to_family(family_id, request)
|
70
68
|
start.uri('/api/user/family')
|
71
69
|
.url_segment(family_id)
|
@@ -80,7 +78,6 @@ module FusionAuth
|
|
80
78
|
# @param action_id [string] The action id of the action to cancel.
|
81
79
|
# @param request [OpenStruct, Hash] The action request that contains the information about the cancellation.
|
82
80
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
83
|
-
#
|
84
81
|
def cancel_action(action_id, request)
|
85
82
|
start.uri('/api/user/action')
|
86
83
|
.url_segment(action_id)
|
@@ -96,7 +93,6 @@ module FusionAuth
|
|
96
93
|
# @param 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.
|
97
94
|
# @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
|
98
95
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
99
|
-
#
|
100
96
|
def change_password(change_password_id, request)
|
101
97
|
start.uri('/api/user/change-password')
|
102
98
|
.url_segment(change_password_id)
|
@@ -112,7 +108,6 @@ module FusionAuth
|
|
112
108
|
#
|
113
109
|
# @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
|
114
110
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
115
|
-
#
|
116
111
|
def change_password_by_identity(request)
|
117
112
|
start.uri('/api/user/change-password')
|
118
113
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -125,7 +120,6 @@ module FusionAuth
|
|
125
120
|
#
|
126
121
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user comment.
|
127
122
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
128
|
-
#
|
129
123
|
def comment_on_user(request)
|
130
124
|
start.uri('/api/user/comment')
|
131
125
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -139,7 +133,6 @@ module FusionAuth
|
|
139
133
|
# @param application_id [string] (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
|
140
134
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application.
|
141
135
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
142
|
-
#
|
143
136
|
def create_application(application_id, request)
|
144
137
|
start.uri('/api/application')
|
145
138
|
.url_segment(application_id)
|
@@ -156,7 +149,6 @@ module FusionAuth
|
|
156
149
|
# @param role_id [string] (Optional) The Id of the role. If not provided a secure random UUID will be generated.
|
157
150
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the application role.
|
158
151
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
159
|
-
#
|
160
152
|
def create_application_role(application_id, role_id, request)
|
161
153
|
start.uri('/api/application')
|
162
154
|
.url_segment(application_id)
|
@@ -174,7 +166,6 @@ module FusionAuth
|
|
174
166
|
#
|
175
167
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the audit log entry.
|
176
168
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
177
|
-
#
|
178
169
|
def create_audit_log(request)
|
179
170
|
start.uri('/api/system/audit-log')
|
180
171
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -188,7 +179,6 @@ module FusionAuth
|
|
188
179
|
# @param consent_id [string] (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
|
189
180
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the consent.
|
190
181
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
191
|
-
#
|
192
182
|
def create_consent(consent_id, request)
|
193
183
|
start.uri('/api/consent')
|
194
184
|
.url_segment(consent_id)
|
@@ -203,7 +193,6 @@ module FusionAuth
|
|
203
193
|
# @param email_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated.
|
204
194
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the email template.
|
205
195
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
206
|
-
#
|
207
196
|
def create_email_template(email_template_id, request)
|
208
197
|
start.uri('/api/email/template')
|
209
198
|
.url_segment(email_template_id)
|
@@ -219,7 +208,6 @@ module FusionAuth
|
|
219
208
|
# @param family_id [string] (Optional) The id for the family. If not provided a secure random UUID will be generated.
|
220
209
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the family.
|
221
210
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
222
|
-
#
|
223
211
|
def create_family(family_id, request)
|
224
212
|
start.uri('/api/user/family')
|
225
213
|
.url_segment(family_id)
|
@@ -234,7 +222,6 @@ module FusionAuth
|
|
234
222
|
# @param group_id [string] (Optional) The Id for the group. If not provided a secure random UUID will be generated.
|
235
223
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group.
|
236
224
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
237
|
-
#
|
238
225
|
def create_group(group_id, request)
|
239
226
|
start.uri('/api/group')
|
240
227
|
.url_segment(group_id)
|
@@ -248,7 +235,6 @@ module FusionAuth
|
|
248
235
|
#
|
249
236
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the group member(s).
|
250
237
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
251
|
-
#
|
252
238
|
def create_group_members(request)
|
253
239
|
start.uri('/api/group/member')
|
254
240
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -262,7 +248,6 @@ module FusionAuth
|
|
262
248
|
# @param identity_provider_id [string] (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
|
263
249
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the identity provider.
|
264
250
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
265
|
-
#
|
266
251
|
def create_identity_provider(identity_provider_id, request)
|
267
252
|
start.uri('/api/identity-provider')
|
268
253
|
.url_segment(identity_provider_id)
|
@@ -277,7 +262,6 @@ module FusionAuth
|
|
277
262
|
# @param lambda_id [string] (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
|
278
263
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the lambda.
|
279
264
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
280
|
-
#
|
281
265
|
def create_lambda(lambda_id, request)
|
282
266
|
start.uri('/api/lambda')
|
283
267
|
.url_segment(lambda_id)
|
@@ -292,7 +276,6 @@ module FusionAuth
|
|
292
276
|
# @param tenant_id [string] (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
|
293
277
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the tenant.
|
294
278
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
295
|
-
#
|
296
279
|
def create_tenant(tenant_id, request)
|
297
280
|
start.uri('/api/tenant')
|
298
281
|
.url_segment(tenant_id)
|
@@ -307,7 +290,6 @@ module FusionAuth
|
|
307
290
|
# @param theme_id [string] (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
|
308
291
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the theme.
|
309
292
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
310
|
-
#
|
311
293
|
def create_theme(theme_id, request)
|
312
294
|
start.uri('/api/theme')
|
313
295
|
.url_segment(theme_id)
|
@@ -322,7 +304,6 @@ module FusionAuth
|
|
322
304
|
# @param user_id [string] (Optional) The Id for the user. If not provided a secure random UUID will be generated.
|
323
305
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user.
|
324
306
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
325
|
-
#
|
326
307
|
def create_user(user_id, request)
|
327
308
|
start.uri('/api/user')
|
328
309
|
.url_segment(user_id)
|
@@ -338,7 +319,6 @@ module FusionAuth
|
|
338
319
|
# @param user_action_id [string] (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
|
339
320
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action.
|
340
321
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
341
|
-
#
|
342
322
|
def create_user_action(user_action_id, request)
|
343
323
|
start.uri('/api/user-action')
|
344
324
|
.url_segment(user_action_id)
|
@@ -354,7 +334,6 @@ module FusionAuth
|
|
354
334
|
# @param user_action_reason_id [string] (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
|
355
335
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the user action reason.
|
356
336
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
357
|
-
#
|
358
337
|
def create_user_action_reason(user_action_reason_id, request)
|
359
338
|
start.uri('/api/user-action-reason')
|
360
339
|
.url_segment(user_action_reason_id)
|
@@ -369,7 +348,6 @@ module FusionAuth
|
|
369
348
|
# @param user_consent_id [string] (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
|
370
349
|
# @param request [OpenStruct, Hash] The request that contains the user consent information.
|
371
350
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
372
|
-
#
|
373
351
|
def create_user_consent(user_consent_id, request)
|
374
352
|
start.uri('/api/user/consent')
|
375
353
|
.url_segment(user_consent_id)
|
@@ -384,7 +362,6 @@ module FusionAuth
|
|
384
362
|
# @param webhook_id [string] (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
|
385
363
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the webhook.
|
386
364
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
387
|
-
#
|
388
365
|
def create_webhook(webhook_id, request)
|
389
366
|
start.uri('/api/webhook')
|
390
367
|
.url_segment(webhook_id)
|
@@ -398,7 +375,6 @@ module FusionAuth
|
|
398
375
|
#
|
399
376
|
# @param application_id [string] The Id of the application to deactivate.
|
400
377
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
401
|
-
#
|
402
378
|
def deactivate_application(application_id)
|
403
379
|
start.uri('/api/application')
|
404
380
|
.url_segment(application_id)
|
@@ -411,7 +387,6 @@ module FusionAuth
|
|
411
387
|
#
|
412
388
|
# @param user_id [string] The Id of the user to deactivate.
|
413
389
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
414
|
-
#
|
415
390
|
def deactivate_user(user_id)
|
416
391
|
start.uri('/api/user')
|
417
392
|
.url_segment(user_id)
|
@@ -424,7 +399,6 @@ module FusionAuth
|
|
424
399
|
#
|
425
400
|
# @param user_action_id [string] The Id of the user action to deactivate.
|
426
401
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
427
|
-
#
|
428
402
|
def deactivate_user_action(user_action_id)
|
429
403
|
start.uri('/api/user-action')
|
430
404
|
.url_segment(user_action_id)
|
@@ -437,10 +411,26 @@ module FusionAuth
|
|
437
411
|
#
|
438
412
|
# @param user_ids [Array] The ids of the users to deactivate.
|
439
413
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
440
|
-
#
|
414
|
+
# @deprecated This method has been renamed to deactivate_users_by_ids, use this method instead.
|
441
415
|
def deactivate_users(user_ids)
|
442
416
|
start.uri('/api/user/bulk')
|
443
417
|
.url_parameter('userId', user_ids)
|
418
|
+
.url_parameter('dryRun', false)
|
419
|
+
.url_parameter('hardDelete', false)
|
420
|
+
.delete()
|
421
|
+
.go()
|
422
|
+
end
|
423
|
+
|
424
|
+
#
|
425
|
+
# Deactivates the users with the given ids.
|
426
|
+
#
|
427
|
+
# @param user_ids [Array] The ids of the users to deactivate.
|
428
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
429
|
+
def deactivate_users_by_ids(user_ids)
|
430
|
+
start.uri('/api/user/bulk')
|
431
|
+
.url_parameter('userId', user_ids)
|
432
|
+
.url_parameter('dryRun', false)
|
433
|
+
.url_parameter('hardDelete', false)
|
444
434
|
.delete()
|
445
435
|
.go()
|
446
436
|
end
|
@@ -453,7 +443,6 @@ module FusionAuth
|
|
453
443
|
#
|
454
444
|
# @param application_id [string] The Id of the application to delete.
|
455
445
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
456
|
-
#
|
457
446
|
def delete_application(application_id)
|
458
447
|
start.uri('/api/application')
|
459
448
|
.url_segment(application_id)
|
@@ -469,7 +458,6 @@ module FusionAuth
|
|
469
458
|
# @param application_id [string] The Id of the application to deactivate.
|
470
459
|
# @param role_id [string] The Id of the role to delete.
|
471
460
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
472
|
-
#
|
473
461
|
def delete_application_role(application_id, role_id)
|
474
462
|
start.uri('/api/application')
|
475
463
|
.url_segment(application_id)
|
@@ -484,7 +472,6 @@ module FusionAuth
|
|
484
472
|
#
|
485
473
|
# @param consent_id [string] The Id of the consent to delete.
|
486
474
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
487
|
-
#
|
488
475
|
def delete_consent(consent_id)
|
489
476
|
start.uri('/api/consent')
|
490
477
|
.url_segment(consent_id)
|
@@ -497,7 +484,6 @@ module FusionAuth
|
|
497
484
|
#
|
498
485
|
# @param email_template_id [string] The Id of the email template to delete.
|
499
486
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
500
|
-
#
|
501
487
|
def delete_email_template(email_template_id)
|
502
488
|
start.uri('/api/email/template')
|
503
489
|
.url_segment(email_template_id)
|
@@ -510,7 +496,6 @@ module FusionAuth
|
|
510
496
|
#
|
511
497
|
# @param group_id [string] The Id of the group to delete.
|
512
498
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
513
|
-
#
|
514
499
|
def delete_group(group_id)
|
515
500
|
start.uri('/api/group')
|
516
501
|
.url_segment(group_id)
|
@@ -523,7 +508,6 @@ module FusionAuth
|
|
523
508
|
#
|
524
509
|
# @param request [OpenStruct, Hash] The member request that contains all of the information used to remove members to the group.
|
525
510
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
526
|
-
#
|
527
511
|
def delete_group_members(request)
|
528
512
|
start.uri('/api/group/member')
|
529
513
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -536,7 +520,6 @@ module FusionAuth
|
|
536
520
|
#
|
537
521
|
# @param identity_provider_id [string] The Id of the identity provider to delete.
|
538
522
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
539
|
-
#
|
540
523
|
def delete_identity_provider(identity_provider_id)
|
541
524
|
start.uri('/api/identity-provider')
|
542
525
|
.url_segment(identity_provider_id)
|
@@ -549,7 +532,6 @@ module FusionAuth
|
|
549
532
|
#
|
550
533
|
# @param key_od [string] The Id of the key to delete.
|
551
534
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
552
|
-
#
|
553
535
|
def delete_key(key_od)
|
554
536
|
start.uri('/api/key')
|
555
537
|
.url_segment(key_od)
|
@@ -562,7 +544,6 @@ module FusionAuth
|
|
562
544
|
#
|
563
545
|
# @param lambda_id [string] The Id of the lambda to delete.
|
564
546
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
565
|
-
#
|
566
547
|
def delete_lambda(lambda_id)
|
567
548
|
start.uri('/api/lambda')
|
568
549
|
.url_segment(lambda_id)
|
@@ -576,7 +557,6 @@ module FusionAuth
|
|
576
557
|
# @param user_id [string] The Id of the user whose registration is being deleted.
|
577
558
|
# @param application_id [string] The Id of the application to remove the registration for.
|
578
559
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
579
|
-
#
|
580
560
|
def delete_registration(user_id, application_id)
|
581
561
|
start.uri('/api/user/registration')
|
582
562
|
.url_segment(user_id)
|
@@ -590,7 +570,6 @@ module FusionAuth
|
|
590
570
|
#
|
591
571
|
# @param tenant_id [string] The Id of the tenant to delete.
|
592
572
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
593
|
-
#
|
594
573
|
def delete_tenant(tenant_id)
|
595
574
|
start.uri('/api/tenant')
|
596
575
|
.url_segment(tenant_id)
|
@@ -603,7 +582,6 @@ module FusionAuth
|
|
603
582
|
#
|
604
583
|
# @param theme_id [string] The Id of the theme to delete.
|
605
584
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
606
|
-
#
|
607
585
|
def delete_theme(theme_id)
|
608
586
|
start.uri('/api/theme')
|
609
587
|
.url_segment(theme_id)
|
@@ -617,7 +595,6 @@ module FusionAuth
|
|
617
595
|
#
|
618
596
|
# @param user_id [string] The Id of the user to delete.
|
619
597
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
620
|
-
#
|
621
598
|
def delete_user(user_id)
|
622
599
|
start.uri('/api/user')
|
623
600
|
.url_segment(user_id)
|
@@ -632,7 +609,6 @@ module FusionAuth
|
|
632
609
|
#
|
633
610
|
# @param user_action_id [string] The Id of the user action to delete.
|
634
611
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
635
|
-
#
|
636
612
|
def delete_user_action(user_action_id)
|
637
613
|
start.uri('/api/user-action')
|
638
614
|
.url_segment(user_action_id)
|
@@ -646,7 +622,6 @@ module FusionAuth
|
|
646
622
|
#
|
647
623
|
# @param user_action_reason_id [string] The Id of the user action reason to delete.
|
648
624
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
649
|
-
#
|
650
625
|
def delete_user_action_reason(user_action_reason_id)
|
651
626
|
start.uri('/api/user-action-reason')
|
652
627
|
.url_segment(user_action_reason_id)
|
@@ -655,11 +630,15 @@ module FusionAuth
|
|
655
630
|
end
|
656
631
|
|
657
632
|
#
|
658
|
-
# Deletes the users with the given ids.
|
633
|
+
# Deletes the users with the given ids, or users matching the provided JSON query or queryString.
|
634
|
+
# The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
|
635
|
+
#
|
636
|
+
# This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
|
637
|
+
# Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
|
659
638
|
#
|
660
|
-
# @param request [OpenStruct, Hash] The
|
639
|
+
# @param request [OpenStruct, Hash] The UserDeleteRequest.
|
661
640
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
662
|
-
#
|
641
|
+
# @deprecated This method has been renamed to delete_users_by_query, use this method instead.
|
663
642
|
def delete_users(request)
|
664
643
|
start.uri('/api/user/bulk')
|
665
644
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -667,12 +646,27 @@ module FusionAuth
|
|
667
646
|
.go()
|
668
647
|
end
|
669
648
|
|
649
|
+
#
|
650
|
+
# Deletes the users with the given ids, or users matching the provided JSON query or queryString.
|
651
|
+
# The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
|
652
|
+
#
|
653
|
+
# This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
|
654
|
+
# Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
|
655
|
+
#
|
656
|
+
# @param request [OpenStruct, Hash] The UserDeleteRequest.
|
657
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
658
|
+
def delete_users_by_query(request)
|
659
|
+
start.uri('/api/user/bulk')
|
660
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
661
|
+
.delete()
|
662
|
+
.go()
|
663
|
+
end
|
664
|
+
|
670
665
|
#
|
671
666
|
# Deletes the webhook for the given Id.
|
672
667
|
#
|
673
668
|
# @param webhook_id [string] The Id of the webhook to delete.
|
674
669
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
675
|
-
#
|
676
670
|
def delete_webhook(webhook_id)
|
677
671
|
start.uri('/api/webhook')
|
678
672
|
.url_segment(webhook_id)
|
@@ -686,7 +680,6 @@ module FusionAuth
|
|
686
680
|
# @param user_id [string] The Id of the User for which you're disabling Two Factor authentication.
|
687
681
|
# @param code [string] The Two Factor code used verify the the caller knows the Two Factor secret.
|
688
682
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
689
|
-
#
|
690
683
|
def disable_two_factor(user_id, code)
|
691
684
|
start.uri('/api/user/two-factor')
|
692
685
|
.url_parameter('userId', user_id)
|
@@ -701,7 +694,6 @@ module FusionAuth
|
|
701
694
|
# @param user_id [string] The Id of the user to enable Two Factor authentication.
|
702
695
|
# @param request [OpenStruct, Hash] The two factor enable request information.
|
703
696
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
704
|
-
#
|
705
697
|
def enable_two_factor(user_id, request)
|
706
698
|
start.uri('/api/user/two-factor')
|
707
699
|
.url_segment(user_id)
|
@@ -719,7 +711,6 @@ module FusionAuth
|
|
719
711
|
# @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
720
712
|
# @param redirect_uri [string] The URI to redirect to upon a successful request.
|
721
713
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
722
|
-
#
|
723
714
|
def exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri)
|
724
715
|
body = {
|
725
716
|
"code" => code,
|
@@ -744,7 +735,6 @@ module FusionAuth
|
|
744
735
|
# @param 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.
|
745
736
|
# @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
746
737
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
747
|
-
#
|
748
738
|
def exchange_refresh_token_for_access_token(refresh_token, client_id, client_secret, scope, user_code)
|
749
739
|
body = {
|
750
740
|
"refresh_token" => refresh_token,
|
@@ -765,7 +755,6 @@ module FusionAuth
|
|
765
755
|
#
|
766
756
|
# @param request [OpenStruct, Hash] The refresh request.
|
767
757
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
768
|
-
#
|
769
758
|
def exchange_refresh_token_for_jwt(request)
|
770
759
|
startAnonymous.uri('/api/jwt/refresh')
|
771
760
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -784,7 +773,6 @@ module FusionAuth
|
|
784
773
|
# @param 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.
|
785
774
|
# @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
786
775
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
787
|
-
#
|
788
776
|
def exchange_user_credentials_for_access_token(username, password, client_id, client_secret, scope, user_code)
|
789
777
|
body = {
|
790
778
|
"username" => username,
|
@@ -806,7 +794,6 @@ module FusionAuth
|
|
806
794
|
#
|
807
795
|
# @param request [OpenStruct, Hash] The request that contains the information about the user so that they can be emailed.
|
808
796
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
809
|
-
#
|
810
797
|
def forgot_password(request)
|
811
798
|
start.uri('/api/user/forgot-password')
|
812
799
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -820,7 +807,6 @@ module FusionAuth
|
|
820
807
|
#
|
821
808
|
# @param email [string] The email address of the user that needs a new verification email.
|
822
809
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
823
|
-
#
|
824
810
|
def generate_email_verification_id(email)
|
825
811
|
start.uri('/api/user/verify-email')
|
826
812
|
.url_parameter('email', email)
|
@@ -835,7 +821,6 @@ module FusionAuth
|
|
835
821
|
# @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
836
822
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key.
|
837
823
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
838
|
-
#
|
839
824
|
def generate_key(key_id, request)
|
840
825
|
start.uri('/api/key/generate')
|
841
826
|
.url_segment(key_id)
|
@@ -851,7 +836,6 @@ module FusionAuth
|
|
851
836
|
# @param email [string] The email address of the user that needs a new verification email.
|
852
837
|
# @param application_id [string] The Id of the application to be verified.
|
853
838
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
854
|
-
#
|
855
839
|
def generate_registration_verification_id(email, application_id)
|
856
840
|
start.uri('/api/user/verify-registration')
|
857
841
|
.url_parameter('email', email)
|
@@ -867,7 +851,6 @@ module FusionAuth
|
|
867
851
|
# application such as Google Authenticator.
|
868
852
|
#
|
869
853
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
870
|
-
#
|
871
854
|
def generate_two_factor_secret()
|
872
855
|
start.uri('/api/two-factor/secret')
|
873
856
|
.get()
|
@@ -881,7 +864,6 @@ module FusionAuth
|
|
881
864
|
#
|
882
865
|
# @param encoded_jwt [string] The encoded JWT (access token).
|
883
866
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
884
|
-
#
|
885
867
|
def generate_two_factor_secret_using_jwt(encoded_jwt)
|
886
868
|
start.uri('/api/two-factor/secret')
|
887
869
|
.authorization('JWT ' + encoded_jwt)
|
@@ -896,7 +878,6 @@ module FusionAuth
|
|
896
878
|
# @param request [OpenStruct, Hash] The third-party login request that contains information from the third-party login
|
897
879
|
# providers that FusionAuth uses to reconcile the user's account.
|
898
880
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
899
|
-
#
|
900
881
|
def identity_provider_login(request)
|
901
882
|
startAnonymous.uri('/api/identity-provider/login')
|
902
883
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -910,7 +891,6 @@ module FusionAuth
|
|
910
891
|
# @param key_id [string] (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
911
892
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to create the key.
|
912
893
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
913
|
-
#
|
914
894
|
def import_key(key_id, request)
|
915
895
|
start.uri('/api/key/import')
|
916
896
|
.url_segment(key_id)
|
@@ -926,7 +906,6 @@ module FusionAuth
|
|
926
906
|
#
|
927
907
|
# @param request [OpenStruct, Hash] The request that contains all of the information about all of the users to import.
|
928
908
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
929
|
-
#
|
930
909
|
def import_users(request)
|
931
910
|
start.uri('/api/user/import')
|
932
911
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -944,7 +923,6 @@ module FusionAuth
|
|
944
923
|
# @param application_id [string] The Application Id for which you are requesting a new access token be issued.
|
945
924
|
# @param encoded_jwt [string] The encoded JWT (access token).
|
946
925
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
947
|
-
#
|
948
926
|
def issue_jwt(application_id, encoded_jwt)
|
949
927
|
start.uri('/api/jwt/issue')
|
950
928
|
.authorization('JWT ' + encoded_jwt)
|
@@ -960,7 +938,6 @@ module FusionAuth
|
|
960
938
|
#
|
961
939
|
# @param request [OpenStruct, Hash] The login request that contains the user credentials used to log them in.
|
962
940
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
963
|
-
#
|
964
941
|
def login(request)
|
965
942
|
start.uri('/api/login')
|
966
943
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -979,7 +956,6 @@ module FusionAuth
|
|
979
956
|
# @param caller_ip_address [string] (Optional) The IP address of the end-user that is logging in. If a null value is provided
|
980
957
|
# the IP address will be that of the client or last proxy that sent the request.
|
981
958
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
982
|
-
#
|
983
959
|
def login_ping(user_id, application_id, caller_ip_address)
|
984
960
|
start.uri('/api/login')
|
985
961
|
.url_segment(user_id)
|
@@ -999,7 +975,6 @@ module FusionAuth
|
|
999
975
|
# @param refresh_token [string] (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
|
1000
976
|
# If provided this takes precedence over the cookie.
|
1001
977
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1002
|
-
#
|
1003
978
|
def logout(global, refresh_token)
|
1004
979
|
startAnonymous.uri('/api/logout')
|
1005
980
|
.url_parameter('global', global)
|
@@ -1014,7 +989,6 @@ module FusionAuth
|
|
1014
989
|
#
|
1015
990
|
# @param domain [string] The domain or email address to lookup.
|
1016
991
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1017
|
-
#
|
1018
992
|
def lookup_identity_provider(domain)
|
1019
993
|
start.uri('/api/identity-provider/lookup')
|
1020
994
|
.url_parameter('domain', domain)
|
@@ -1029,7 +1003,6 @@ module FusionAuth
|
|
1029
1003
|
# @param action_id [string] The Id of the action to modify. This is technically the user action log id.
|
1030
1004
|
# @param request [OpenStruct, Hash] The request that contains all of the information about the modification.
|
1031
1005
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1032
|
-
#
|
1033
1006
|
def modify_action(action_id, request)
|
1034
1007
|
start.uri('/api/user/action')
|
1035
1008
|
.url_segment(action_id)
|
@@ -1043,7 +1016,6 @@ module FusionAuth
|
|
1043
1016
|
#
|
1044
1017
|
# @param request [OpenStruct, Hash] The passwordless login request that contains all of the information used to complete login.
|
1045
1018
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1046
|
-
#
|
1047
1019
|
def passwordless_login(request)
|
1048
1020
|
startAnonymous.uri('/api/passwordless/login')
|
1049
1021
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -1057,7 +1029,6 @@ module FusionAuth
|
|
1057
1029
|
# @param application_id [string] The Id of the application to update.
|
1058
1030
|
# @param request [OpenStruct, Hash] The request that contains just the new application information.
|
1059
1031
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1060
|
-
#
|
1061
1032
|
def patch_application(application_id, request)
|
1062
1033
|
start.uri('/api/application')
|
1063
1034
|
.url_segment(application_id)
|
@@ -1073,7 +1044,6 @@ module FusionAuth
|
|
1073
1044
|
# @param role_id [string] The Id of the role to update.
|
1074
1045
|
# @param request [OpenStruct, Hash] The request that contains just the new role information.
|
1075
1046
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1076
|
-
#
|
1077
1047
|
def patch_application_role(application_id, role_id, request)
|
1078
1048
|
start.uri('/api/application')
|
1079
1049
|
.url_segment(application_id)
|
@@ -1090,7 +1060,6 @@ module FusionAuth
|
|
1090
1060
|
# @param consent_id [string] The Id of the consent to update.
|
1091
1061
|
# @param request [OpenStruct, Hash] The request that contains just the new consent information.
|
1092
1062
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1093
|
-
#
|
1094
1063
|
def patch_consent(consent_id, request)
|
1095
1064
|
start.uri('/api/consent')
|
1096
1065
|
.url_segment(consent_id)
|
@@ -1105,7 +1074,6 @@ module FusionAuth
|
|
1105
1074
|
# @param email_template_id [string] The Id of the email template to update.
|
1106
1075
|
# @param request [OpenStruct, Hash] The request that contains just the new email template information.
|
1107
1076
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1108
|
-
#
|
1109
1077
|
def patch_email_template(email_template_id, request)
|
1110
1078
|
start.uri('/api/email/template')
|
1111
1079
|
.url_segment(email_template_id)
|
@@ -1120,7 +1088,6 @@ module FusionAuth
|
|
1120
1088
|
# @param group_id [string] The Id of the group to update.
|
1121
1089
|
# @param request [OpenStruct, Hash] The request that contains just the new group information.
|
1122
1090
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1123
|
-
#
|
1124
1091
|
def patch_group(group_id, request)
|
1125
1092
|
start.uri('/api/group')
|
1126
1093
|
.url_segment(group_id)
|
@@ -1135,7 +1102,6 @@ module FusionAuth
|
|
1135
1102
|
# @param identity_provider_id [string] The Id of the identity provider to update.
|
1136
1103
|
# @param request [OpenStruct, Hash] The request object that contains just the updated identity provider information.
|
1137
1104
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1138
|
-
#
|
1139
1105
|
def patch_identity_provider(identity_provider_id, request)
|
1140
1106
|
start.uri('/api/identity-provider')
|
1141
1107
|
.url_segment(identity_provider_id)
|
@@ -1149,7 +1115,6 @@ module FusionAuth
|
|
1149
1115
|
#
|
1150
1116
|
# @param request [OpenStruct, Hash] The request that contains just the new integration information.
|
1151
1117
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1152
|
-
#
|
1153
1118
|
def patch_integrations(request)
|
1154
1119
|
start.uri('/api/integration')
|
1155
1120
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -1163,7 +1128,6 @@ module FusionAuth
|
|
1163
1128
|
# @param lambda_id [string] The Id of the lambda to update.
|
1164
1129
|
# @param request [OpenStruct, Hash] The request that contains just the new lambda information.
|
1165
1130
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1166
|
-
#
|
1167
1131
|
def patch_lambda(lambda_id, request)
|
1168
1132
|
start.uri('/api/lambda')
|
1169
1133
|
.url_segment(lambda_id)
|
@@ -1178,7 +1142,6 @@ module FusionAuth
|
|
1178
1142
|
# @param user_id [string] The Id of the user whose registration is going to be updated.
|
1179
1143
|
# @param request [OpenStruct, Hash] The request that contains just the new registration information.
|
1180
1144
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1181
|
-
#
|
1182
1145
|
def patch_registration(user_id, request)
|
1183
1146
|
start.uri('/api/user/registration')
|
1184
1147
|
.url_segment(user_id)
|
@@ -1192,7 +1155,6 @@ module FusionAuth
|
|
1192
1155
|
#
|
1193
1156
|
# @param request [OpenStruct, Hash] The request that contains just the new system configuration information.
|
1194
1157
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1195
|
-
#
|
1196
1158
|
def patch_system_configuration(request)
|
1197
1159
|
start.uri('/api/system-configuration')
|
1198
1160
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -1206,7 +1168,6 @@ module FusionAuth
|
|
1206
1168
|
# @param tenant_id [string] The Id of the tenant to update.
|
1207
1169
|
# @param request [OpenStruct, Hash] The request that contains just the new tenant information.
|
1208
1170
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1209
|
-
#
|
1210
1171
|
def patch_tenant(tenant_id, request)
|
1211
1172
|
start.uri('/api/tenant')
|
1212
1173
|
.url_segment(tenant_id)
|
@@ -1221,7 +1182,6 @@ module FusionAuth
|
|
1221
1182
|
# @param theme_id [string] The Id of the theme to update.
|
1222
1183
|
# @param request [OpenStruct, Hash] The request that contains just the new theme information.
|
1223
1184
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1224
|
-
#
|
1225
1185
|
def patch_theme(theme_id, request)
|
1226
1186
|
start.uri('/api/theme')
|
1227
1187
|
.url_segment(theme_id)
|
@@ -1236,7 +1196,6 @@ module FusionAuth
|
|
1236
1196
|
# @param user_id [string] The Id of the user to update.
|
1237
1197
|
# @param request [OpenStruct, Hash] The request that contains just the new user information.
|
1238
1198
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1239
|
-
#
|
1240
1199
|
def patch_user(user_id, request)
|
1241
1200
|
start.uri('/api/user')
|
1242
1201
|
.url_segment(user_id)
|
@@ -1251,7 +1210,6 @@ module FusionAuth
|
|
1251
1210
|
# @param user_action_id [string] The Id of the user action to update.
|
1252
1211
|
# @param request [OpenStruct, Hash] The request that contains just the new user action information.
|
1253
1212
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1254
|
-
#
|
1255
1213
|
def patch_user_action(user_action_id, request)
|
1256
1214
|
start.uri('/api/user-action')
|
1257
1215
|
.url_segment(user_action_id)
|
@@ -1266,7 +1224,6 @@ module FusionAuth
|
|
1266
1224
|
# @param user_action_reason_id [string] The Id of the user action reason to update.
|
1267
1225
|
# @param request [OpenStruct, Hash] The request that contains just the new user action reason information.
|
1268
1226
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1269
|
-
#
|
1270
1227
|
def patch_user_action_reason(user_action_reason_id, request)
|
1271
1228
|
start.uri('/api/user-action-reason')
|
1272
1229
|
.url_segment(user_action_reason_id)
|
@@ -1281,7 +1238,6 @@ module FusionAuth
|
|
1281
1238
|
# @param user_consent_id [string] The User Consent Id
|
1282
1239
|
# @param request [OpenStruct, Hash] The request that contains just the new user consent information.
|
1283
1240
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1284
|
-
#
|
1285
1241
|
def patch_user_consent(user_consent_id, request)
|
1286
1242
|
start.uri('/api/user/consent')
|
1287
1243
|
.url_segment(user_consent_id)
|
@@ -1295,7 +1251,6 @@ module FusionAuth
|
|
1295
1251
|
#
|
1296
1252
|
# @param application_id [string] The Id of the application to reactivate.
|
1297
1253
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1298
|
-
#
|
1299
1254
|
def reactivate_application(application_id)
|
1300
1255
|
start.uri('/api/application')
|
1301
1256
|
.url_segment(application_id)
|
@@ -1309,7 +1264,6 @@ module FusionAuth
|
|
1309
1264
|
#
|
1310
1265
|
# @param user_id [string] The Id of the user to reactivate.
|
1311
1266
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1312
|
-
#
|
1313
1267
|
def reactivate_user(user_id)
|
1314
1268
|
start.uri('/api/user')
|
1315
1269
|
.url_segment(user_id)
|
@@ -1323,7 +1277,6 @@ module FusionAuth
|
|
1323
1277
|
#
|
1324
1278
|
# @param user_action_id [string] The Id of the user action to reactivate.
|
1325
1279
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1326
|
-
#
|
1327
1280
|
def reactivate_user_action(user_action_id)
|
1328
1281
|
start.uri('/api/user-action')
|
1329
1282
|
.url_segment(user_action_id)
|
@@ -1337,7 +1290,6 @@ module FusionAuth
|
|
1337
1290
|
#
|
1338
1291
|
# @param request [OpenStruct, Hash] The reconcile request that contains the data to reconcile the User.
|
1339
1292
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1340
|
-
#
|
1341
1293
|
def reconcile_jwt(request)
|
1342
1294
|
startAnonymous.uri('/api/jwt/reconcile')
|
1343
1295
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -1352,7 +1304,6 @@ module FusionAuth
|
|
1352
1304
|
# ensure the index immediately current before making a query request to the search index.
|
1353
1305
|
#
|
1354
1306
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1355
|
-
#
|
1356
1307
|
def refresh_user_search_index()
|
1357
1308
|
start.uri('/api/user/search')
|
1358
1309
|
.put()
|
@@ -1369,7 +1320,6 @@ module FusionAuth
|
|
1369
1320
|
# @param user_id [string] (Optional) The Id of the user being registered for the application and optionally created.
|
1370
1321
|
# @param request [OpenStruct, Hash] The request that optionally contains the User and must contain the UserRegistration.
|
1371
1322
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1372
|
-
#
|
1373
1323
|
def register(user_id, request)
|
1374
1324
|
start.uri('/api/user/registration')
|
1375
1325
|
.url_segment(user_id)
|
@@ -1384,7 +1334,6 @@ module FusionAuth
|
|
1384
1334
|
# @param family_id [string] The id of the family to remove the user from.
|
1385
1335
|
# @param user_id [string] The id of the user to remove from the family.
|
1386
1336
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1387
|
-
#
|
1388
1337
|
def remove_user_from_family(family_id, user_id)
|
1389
1338
|
start.uri('/api/user/family')
|
1390
1339
|
.url_segment(family_id)
|
@@ -1398,7 +1347,6 @@ module FusionAuth
|
|
1398
1347
|
#
|
1399
1348
|
# @param email [string] The email address of the user that needs a new verification email.
|
1400
1349
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1401
|
-
#
|
1402
1350
|
def resend_email_verification(email)
|
1403
1351
|
start.uri('/api/user/verify-email')
|
1404
1352
|
.url_parameter('email', email)
|
@@ -1412,7 +1360,6 @@ module FusionAuth
|
|
1412
1360
|
# @param email [string] The email address of the user that needs a new verification email.
|
1413
1361
|
# @param application_id [string] The Id of the application to be verified.
|
1414
1362
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1415
|
-
#
|
1416
1363
|
def resend_registration_verification(email, application_id)
|
1417
1364
|
start.uri('/api/user/verify-registration')
|
1418
1365
|
.url_parameter('email', email)
|
@@ -1426,7 +1373,6 @@ module FusionAuth
|
|
1426
1373
|
#
|
1427
1374
|
# @param action_id [string] The Id of the action to retrieve.
|
1428
1375
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1429
|
-
#
|
1430
1376
|
def retrieve_action(action_id)
|
1431
1377
|
start.uri('/api/user/action')
|
1432
1378
|
.url_segment(action_id)
|
@@ -1440,7 +1386,6 @@ module FusionAuth
|
|
1440
1386
|
#
|
1441
1387
|
# @param user_id [string] The Id of the user to fetch the actions for.
|
1442
1388
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1443
|
-
#
|
1444
1389
|
def retrieve_actions(user_id)
|
1445
1390
|
start.uri('/api/user/action')
|
1446
1391
|
.url_parameter('userId', user_id)
|
@@ -1453,7 +1398,6 @@ module FusionAuth
|
|
1453
1398
|
#
|
1454
1399
|
# @param user_id [string] The Id of the user to fetch the actions for.
|
1455
1400
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1456
|
-
#
|
1457
1401
|
def retrieve_actions_preventing_login(user_id)
|
1458
1402
|
start.uri('/api/user/action')
|
1459
1403
|
.url_parameter('userId', user_id)
|
@@ -1468,7 +1412,6 @@ module FusionAuth
|
|
1468
1412
|
#
|
1469
1413
|
# @param user_id [string] The Id of the user to fetch the actions for.
|
1470
1414
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1471
|
-
#
|
1472
1415
|
def retrieve_active_actions(user_id)
|
1473
1416
|
start.uri('/api/user/action')
|
1474
1417
|
.url_parameter('userId', user_id)
|
@@ -1482,7 +1425,6 @@ module FusionAuth
|
|
1482
1425
|
#
|
1483
1426
|
# @param application_id [string] (Optional) The application id.
|
1484
1427
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1485
|
-
#
|
1486
1428
|
def retrieve_application(application_id)
|
1487
1429
|
start.uri('/api/application')
|
1488
1430
|
.url_segment(application_id)
|
@@ -1494,7 +1436,6 @@ module FusionAuth
|
|
1494
1436
|
# Retrieves all of the applications.
|
1495
1437
|
#
|
1496
1438
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1497
|
-
#
|
1498
1439
|
def retrieve_applications()
|
1499
1440
|
start.uri('/api/application')
|
1500
1441
|
.get()
|
@@ -1506,7 +1447,6 @@ module FusionAuth
|
|
1506
1447
|
#
|
1507
1448
|
# @param audit_log_id [Numeric] The Id of the audit log to retrieve.
|
1508
1449
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1509
|
-
#
|
1510
1450
|
def retrieve_audit_log(audit_log_id)
|
1511
1451
|
start.uri('/api/system/audit-log')
|
1512
1452
|
.url_segment(audit_log_id)
|
@@ -1519,7 +1459,6 @@ module FusionAuth
|
|
1519
1459
|
#
|
1520
1460
|
# @param consent_id [string] The Id of the consent.
|
1521
1461
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1522
|
-
#
|
1523
1462
|
def retrieve_consent(consent_id)
|
1524
1463
|
start.uri('/api/consent')
|
1525
1464
|
.url_segment(consent_id)
|
@@ -1531,7 +1470,6 @@ module FusionAuth
|
|
1531
1470
|
# Retrieves all of the consent.
|
1532
1471
|
#
|
1533
1472
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1534
|
-
#
|
1535
1473
|
def retrieve_consents()
|
1536
1474
|
start.uri('/api/consent')
|
1537
1475
|
.get()
|
@@ -1546,7 +1484,6 @@ module FusionAuth
|
|
1546
1484
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
1547
1485
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
1548
1486
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1549
|
-
#
|
1550
1487
|
def retrieve_daily_active_report(application_id, start, _end)
|
1551
1488
|
start.uri('/api/report/daily-active-user')
|
1552
1489
|
.url_parameter('applicationId', application_id)
|
@@ -1561,7 +1498,6 @@ module FusionAuth
|
|
1561
1498
|
#
|
1562
1499
|
# @param email_template_id [string] (Optional) The Id of the email template.
|
1563
1500
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1564
|
-
#
|
1565
1501
|
def retrieve_email_template(email_template_id)
|
1566
1502
|
start.uri('/api/email/template')
|
1567
1503
|
.url_segment(email_template_id)
|
@@ -1576,7 +1512,6 @@ module FusionAuth
|
|
1576
1512
|
#
|
1577
1513
|
# @param request [OpenStruct, Hash] The request that contains the email template and optionally a locale to render it in.
|
1578
1514
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1579
|
-
#
|
1580
1515
|
def retrieve_email_template_preview(request)
|
1581
1516
|
start.uri('/api/email/template/preview')
|
1582
1517
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -1588,7 +1523,6 @@ module FusionAuth
|
|
1588
1523
|
# Retrieves all of the email templates.
|
1589
1524
|
#
|
1590
1525
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1591
|
-
#
|
1592
1526
|
def retrieve_email_templates()
|
1593
1527
|
start.uri('/api/email/template')
|
1594
1528
|
.get()
|
@@ -1600,7 +1534,6 @@ module FusionAuth
|
|
1600
1534
|
#
|
1601
1535
|
# @param event_log_id [Numeric] The Id of the event log to retrieve.
|
1602
1536
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1603
|
-
#
|
1604
1537
|
def retrieve_event_log(event_log_id)
|
1605
1538
|
start.uri('/api/system/event-log')
|
1606
1539
|
.url_segment(event_log_id)
|
@@ -1613,7 +1546,6 @@ module FusionAuth
|
|
1613
1546
|
#
|
1614
1547
|
# @param user_id [string] The User's id
|
1615
1548
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1616
|
-
#
|
1617
1549
|
def retrieve_families(user_id)
|
1618
1550
|
start.uri('/api/user/family')
|
1619
1551
|
.url_parameter('userId', user_id)
|
@@ -1626,7 +1558,6 @@ module FusionAuth
|
|
1626
1558
|
#
|
1627
1559
|
# @param family_id [string] The unique Id of the Family.
|
1628
1560
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1629
|
-
#
|
1630
1561
|
def retrieve_family_members_by_family_id(family_id)
|
1631
1562
|
start.uri('/api/user/family')
|
1632
1563
|
.url_segment(family_id)
|
@@ -1639,7 +1570,6 @@ module FusionAuth
|
|
1639
1570
|
#
|
1640
1571
|
# @param group_id [string] The Id of the group.
|
1641
1572
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1642
|
-
#
|
1643
1573
|
def retrieve_group(group_id)
|
1644
1574
|
start.uri('/api/group')
|
1645
1575
|
.url_segment(group_id)
|
@@ -1651,7 +1581,6 @@ module FusionAuth
|
|
1651
1581
|
# Retrieves all of the groups.
|
1652
1582
|
#
|
1653
1583
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1654
|
-
#
|
1655
1584
|
def retrieve_groups()
|
1656
1585
|
start.uri('/api/group')
|
1657
1586
|
.get()
|
@@ -1663,7 +1592,6 @@ module FusionAuth
|
|
1663
1592
|
#
|
1664
1593
|
# @param identity_provider_id [string] (Optional) The identity provider id.
|
1665
1594
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1666
|
-
#
|
1667
1595
|
def retrieve_identity_provider(identity_provider_id)
|
1668
1596
|
start.uri('/api/identity-provider')
|
1669
1597
|
.url_segment(identity_provider_id)
|
@@ -1675,7 +1603,6 @@ module FusionAuth
|
|
1675
1603
|
# Retrieves all of the identity providers.
|
1676
1604
|
#
|
1677
1605
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1678
|
-
#
|
1679
1606
|
def retrieve_identity_providers()
|
1680
1607
|
start.uri('/api/identity-provider')
|
1681
1608
|
.get()
|
@@ -1688,7 +1615,6 @@ module FusionAuth
|
|
1688
1615
|
#
|
1689
1616
|
# @param user_id [string] The Id of the user to fetch the actions for.
|
1690
1617
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1691
|
-
#
|
1692
1618
|
def retrieve_inactive_actions(user_id)
|
1693
1619
|
start.uri('/api/user/action')
|
1694
1620
|
.url_parameter('userId', user_id)
|
@@ -1701,7 +1627,6 @@ module FusionAuth
|
|
1701
1627
|
# Retrieves all of the applications that are currently inactive.
|
1702
1628
|
#
|
1703
1629
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1704
|
-
#
|
1705
1630
|
def retrieve_inactive_applications()
|
1706
1631
|
start.uri('/api/application')
|
1707
1632
|
.url_parameter('inactive', true)
|
@@ -1713,7 +1638,6 @@ module FusionAuth
|
|
1713
1638
|
# Retrieves all of the user actions that are currently inactive.
|
1714
1639
|
#
|
1715
1640
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1716
|
-
#
|
1717
1641
|
def retrieve_inactive_user_actions()
|
1718
1642
|
start.uri('/api/user-action')
|
1719
1643
|
.url_parameter('inactive', true)
|
@@ -1725,7 +1649,6 @@ module FusionAuth
|
|
1725
1649
|
# Retrieves the available integrations.
|
1726
1650
|
#
|
1727
1651
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1728
|
-
#
|
1729
1652
|
def retrieve_integration()
|
1730
1653
|
start.uri('/api/integration')
|
1731
1654
|
.get()
|
@@ -1737,7 +1660,6 @@ module FusionAuth
|
|
1737
1660
|
#
|
1738
1661
|
# @param key_id [string] The Id of the public key (kid).
|
1739
1662
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1740
|
-
#
|
1741
1663
|
def retrieve_jwt_public_key(key_id)
|
1742
1664
|
startAnonymous.uri('/api/jwt/public-key')
|
1743
1665
|
.url_parameter('kid', key_id)
|
@@ -1750,7 +1672,6 @@ module FusionAuth
|
|
1750
1672
|
#
|
1751
1673
|
# @param application_id [string] The Id of the Application for which this key is used.
|
1752
1674
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1753
|
-
#
|
1754
1675
|
def retrieve_jwt_public_key_by_application_id(application_id)
|
1755
1676
|
startAnonymous.uri('/api/jwt/public-key')
|
1756
1677
|
.url_parameter('applicationId', application_id)
|
@@ -1762,7 +1683,6 @@ module FusionAuth
|
|
1762
1683
|
# Retrieves all Public Keys configured for verifying JSON Web Tokens (JWT).
|
1763
1684
|
#
|
1764
1685
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1765
|
-
#
|
1766
1686
|
def retrieve_jwt_public_keys()
|
1767
1687
|
startAnonymous.uri('/api/jwt/public-key')
|
1768
1688
|
.get()
|
@@ -1773,7 +1693,6 @@ module FusionAuth
|
|
1773
1693
|
# Returns public keys used by FusionAuth to cryptographically verify JWTs using the JSON Web Key format.
|
1774
1694
|
#
|
1775
1695
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1776
|
-
#
|
1777
1696
|
def retrieve_json_web_key_set()
|
1778
1697
|
startAnonymous.uri('/.well-known/jwks.json')
|
1779
1698
|
.get()
|
@@ -1785,7 +1704,6 @@ module FusionAuth
|
|
1785
1704
|
#
|
1786
1705
|
# @param key_id [string] The Id of the key.
|
1787
1706
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1788
|
-
#
|
1789
1707
|
def retrieve_key(key_id)
|
1790
1708
|
start.uri('/api/key')
|
1791
1709
|
.url_segment(key_id)
|
@@ -1797,7 +1715,6 @@ module FusionAuth
|
|
1797
1715
|
# Retrieves all of the keys.
|
1798
1716
|
#
|
1799
1717
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1800
|
-
#
|
1801
1718
|
def retrieve_keys()
|
1802
1719
|
start.uri('/api/key')
|
1803
1720
|
.get()
|
@@ -1809,7 +1726,6 @@ module FusionAuth
|
|
1809
1726
|
#
|
1810
1727
|
# @param lambda_id [string] The Id of the lambda.
|
1811
1728
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1812
|
-
#
|
1813
1729
|
def retrieve_lambda(lambda_id)
|
1814
1730
|
start.uri('/api/lambda')
|
1815
1731
|
.url_segment(lambda_id)
|
@@ -1821,7 +1737,6 @@ module FusionAuth
|
|
1821
1737
|
# Retrieves all of the lambdas.
|
1822
1738
|
#
|
1823
1739
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1824
|
-
#
|
1825
1740
|
def retrieve_lambdas()
|
1826
1741
|
start.uri('/api/lambda')
|
1827
1742
|
.get()
|
@@ -1833,7 +1748,6 @@ module FusionAuth
|
|
1833
1748
|
#
|
1834
1749
|
# @param type [OpenStruct, Hash] The type of the lambda to return.
|
1835
1750
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1836
|
-
#
|
1837
1751
|
def retrieve_lambdas_by_type(type)
|
1838
1752
|
start.uri('/api/lambda')
|
1839
1753
|
.url_parameter('type', type)
|
@@ -1849,7 +1763,6 @@ module FusionAuth
|
|
1849
1763
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
1850
1764
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
1851
1765
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1852
|
-
#
|
1853
1766
|
def retrieve_login_report(application_id, start, _end)
|
1854
1767
|
start.uri('/api/report/login')
|
1855
1768
|
.url_parameter('applicationId', application_id)
|
@@ -1867,7 +1780,6 @@ module FusionAuth
|
|
1867
1780
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
1868
1781
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
1869
1782
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1870
|
-
#
|
1871
1783
|
def retrieve_monthly_active_report(application_id, start, _end)
|
1872
1784
|
start.uri('/api/report/monthly-active-user')
|
1873
1785
|
.url_parameter('applicationId', application_id)
|
@@ -1882,7 +1794,6 @@ module FusionAuth
|
|
1882
1794
|
#
|
1883
1795
|
# @param application_id [string] The Id of the Application to retrieve OAuth configuration.
|
1884
1796
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1885
|
-
#
|
1886
1797
|
def retrieve_oauth_configuration(application_id)
|
1887
1798
|
start.uri('/api/application')
|
1888
1799
|
.url_segment(application_id)
|
@@ -1895,7 +1806,6 @@ module FusionAuth
|
|
1895
1806
|
# Returns the well known OpenID Configuration JSON document
|
1896
1807
|
#
|
1897
1808
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1898
|
-
#
|
1899
1809
|
def retrieve_open_id_configuration()
|
1900
1810
|
startAnonymous.uri('/.well-known/openid-configuration')
|
1901
1811
|
.get()
|
@@ -1909,7 +1819,6 @@ module FusionAuth
|
|
1909
1819
|
# This API does not require an API key.
|
1910
1820
|
#
|
1911
1821
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1912
|
-
#
|
1913
1822
|
def retrieve_password_validation_rules()
|
1914
1823
|
startAnonymous.uri('/api/tenant/password-validation-rules')
|
1915
1824
|
.get()
|
@@ -1923,7 +1832,6 @@ module FusionAuth
|
|
1923
1832
|
#
|
1924
1833
|
# @param tenant_id [string] The Id of the tenant.
|
1925
1834
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1926
|
-
#
|
1927
1835
|
def retrieve_password_validation_rules_with_tenant_id(tenant_id)
|
1928
1836
|
startAnonymous.uri('/api/tenant/password-validation-rules')
|
1929
1837
|
.url_segment(tenant_id)
|
@@ -1936,7 +1844,6 @@ module FusionAuth
|
|
1936
1844
|
#
|
1937
1845
|
# @param parent_email [string] The email of the parent.
|
1938
1846
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1939
|
-
#
|
1940
1847
|
def retrieve_pending_children(parent_email)
|
1941
1848
|
start.uri('/api/user/family/pending')
|
1942
1849
|
.url_parameter('parentEmail', parent_email)
|
@@ -1950,7 +1857,6 @@ module FusionAuth
|
|
1950
1857
|
# @param offset [Numeric] The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
|
1951
1858
|
# @param limit [Numeric] (Optional, defaults to 10) The number of records to retrieve.
|
1952
1859
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1953
|
-
#
|
1954
1860
|
def retrieve_recent_logins(offset, limit)
|
1955
1861
|
start.uri('/api/user/recent-login')
|
1956
1862
|
.url_parameter('offset', offset)
|
@@ -1964,7 +1870,6 @@ module FusionAuth
|
|
1964
1870
|
#
|
1965
1871
|
# @param user_id [string] The Id of the user.
|
1966
1872
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1967
|
-
#
|
1968
1873
|
def retrieve_refresh_tokens(user_id)
|
1969
1874
|
start.uri('/api/jwt/refresh')
|
1970
1875
|
.url_parameter('userId', user_id)
|
@@ -1978,7 +1883,6 @@ module FusionAuth
|
|
1978
1883
|
# @param user_id [string] The Id of the user.
|
1979
1884
|
# @param application_id [string] The Id of the application.
|
1980
1885
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1981
|
-
#
|
1982
1886
|
def retrieve_registration(user_id, application_id)
|
1983
1887
|
start.uri('/api/user/registration')
|
1984
1888
|
.url_segment(user_id)
|
@@ -1995,7 +1899,6 @@ module FusionAuth
|
|
1995
1899
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
1996
1900
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
1997
1901
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
1998
|
-
#
|
1999
1902
|
def retrieve_registration_report(application_id, start, _end)
|
2000
1903
|
start.uri('/api/report/registration')
|
2001
1904
|
.url_parameter('applicationId', application_id)
|
@@ -2009,7 +1912,6 @@ module FusionAuth
|
|
2009
1912
|
# Retrieves the system configuration.
|
2010
1913
|
#
|
2011
1914
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2012
|
-
#
|
2013
1915
|
def retrieve_system_configuration()
|
2014
1916
|
start.uri('/api/system-configuration')
|
2015
1917
|
.get()
|
@@ -2021,7 +1923,6 @@ module FusionAuth
|
|
2021
1923
|
#
|
2022
1924
|
# @param tenant_id [string] The Id of the tenant.
|
2023
1925
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2024
|
-
#
|
2025
1926
|
def retrieve_tenant(tenant_id)
|
2026
1927
|
start.uri('/api/tenant')
|
2027
1928
|
.url_segment(tenant_id)
|
@@ -2033,7 +1934,6 @@ module FusionAuth
|
|
2033
1934
|
# Retrieves all of the tenants.
|
2034
1935
|
#
|
2035
1936
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2036
|
-
#
|
2037
1937
|
def retrieve_tenants()
|
2038
1938
|
start.uri('/api/tenant')
|
2039
1939
|
.get()
|
@@ -2045,7 +1945,6 @@ module FusionAuth
|
|
2045
1945
|
#
|
2046
1946
|
# @param theme_id [string] The Id of the theme.
|
2047
1947
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2048
|
-
#
|
2049
1948
|
def retrieve_theme(theme_id)
|
2050
1949
|
start.uri('/api/theme')
|
2051
1950
|
.url_segment(theme_id)
|
@@ -2057,7 +1956,6 @@ module FusionAuth
|
|
2057
1956
|
# Retrieves all of the themes.
|
2058
1957
|
#
|
2059
1958
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2060
|
-
#
|
2061
1959
|
def retrieve_themes()
|
2062
1960
|
start.uri('/api/theme')
|
2063
1961
|
.get()
|
@@ -2069,7 +1967,6 @@ module FusionAuth
|
|
2069
1967
|
# count.
|
2070
1968
|
#
|
2071
1969
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2072
|
-
#
|
2073
1970
|
def retrieve_total_report()
|
2074
1971
|
start.uri('/api/report/totals')
|
2075
1972
|
.get()
|
@@ -2081,7 +1978,6 @@ module FusionAuth
|
|
2081
1978
|
#
|
2082
1979
|
# @param user_id [string] The Id of the user.
|
2083
1980
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2084
|
-
#
|
2085
1981
|
def retrieve_user(user_id)
|
2086
1982
|
start.uri('/api/user')
|
2087
1983
|
.url_segment(user_id)
|
@@ -2095,7 +1991,6 @@ module FusionAuth
|
|
2095
1991
|
#
|
2096
1992
|
# @param user_action_id [string] (Optional) The Id of the user action.
|
2097
1993
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2098
|
-
#
|
2099
1994
|
def retrieve_user_action(user_action_id)
|
2100
1995
|
start.uri('/api/user-action')
|
2101
1996
|
.url_segment(user_action_id)
|
@@ -2109,7 +2004,6 @@ module FusionAuth
|
|
2109
2004
|
#
|
2110
2005
|
# @param user_action_reason_id [string] (Optional) The Id of the user action reason.
|
2111
2006
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2112
|
-
#
|
2113
2007
|
def retrieve_user_action_reason(user_action_reason_id)
|
2114
2008
|
start.uri('/api/user-action-reason')
|
2115
2009
|
.url_segment(user_action_reason_id)
|
@@ -2121,7 +2015,6 @@ module FusionAuth
|
|
2121
2015
|
# Retrieves all the user action reasons.
|
2122
2016
|
#
|
2123
2017
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2124
|
-
#
|
2125
2018
|
def retrieve_user_action_reasons()
|
2126
2019
|
start.uri('/api/user-action-reason')
|
2127
2020
|
.get()
|
@@ -2132,7 +2025,6 @@ module FusionAuth
|
|
2132
2025
|
# Retrieves all of the user actions.
|
2133
2026
|
#
|
2134
2027
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2135
|
-
#
|
2136
2028
|
def retrieve_user_actions()
|
2137
2029
|
start.uri('/api/user-action')
|
2138
2030
|
.get()
|
@@ -2145,7 +2037,6 @@ module FusionAuth
|
|
2145
2037
|
#
|
2146
2038
|
# @param change_password_id [string] The unique change password Id that was sent via email or returned by the Forgot Password API.
|
2147
2039
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2148
|
-
#
|
2149
2040
|
def retrieve_user_by_change_password_id(change_password_id)
|
2150
2041
|
start.uri('/api/user')
|
2151
2042
|
.url_parameter('changePasswordId', change_password_id)
|
@@ -2158,7 +2049,6 @@ module FusionAuth
|
|
2158
2049
|
#
|
2159
2050
|
# @param email [string] The email of the user.
|
2160
2051
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2161
|
-
#
|
2162
2052
|
def retrieve_user_by_email(email)
|
2163
2053
|
start.uri('/api/user')
|
2164
2054
|
.url_parameter('email', email)
|
@@ -2171,7 +2061,6 @@ module FusionAuth
|
|
2171
2061
|
#
|
2172
2062
|
# @param login_id [string] The email or username of the user.
|
2173
2063
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2174
|
-
#
|
2175
2064
|
def retrieve_user_by_login_id(login_id)
|
2176
2065
|
start.uri('/api/user')
|
2177
2066
|
.url_parameter('loginId', login_id)
|
@@ -2184,7 +2073,6 @@ module FusionAuth
|
|
2184
2073
|
#
|
2185
2074
|
# @param username [string] The username of the user.
|
2186
2075
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2187
|
-
#
|
2188
2076
|
def retrieve_user_by_username(username)
|
2189
2077
|
start.uri('/api/user')
|
2190
2078
|
.url_parameter('username', username)
|
@@ -2198,7 +2086,6 @@ module FusionAuth
|
|
2198
2086
|
#
|
2199
2087
|
# @param verification_id [string] The unique verification Id that has been set on the user object.
|
2200
2088
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2201
|
-
#
|
2202
2089
|
def retrieve_user_by_verification_id(verification_id)
|
2203
2090
|
start.uri('/api/user')
|
2204
2091
|
.url_parameter('verificationId', verification_id)
|
@@ -2211,7 +2098,6 @@ module FusionAuth
|
|
2211
2098
|
#
|
2212
2099
|
# @param user_id [string] The Id of the user.
|
2213
2100
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2214
|
-
#
|
2215
2101
|
def retrieve_user_comments(user_id)
|
2216
2102
|
start.uri('/api/user/comment')
|
2217
2103
|
.url_segment(user_id)
|
@@ -2224,7 +2110,6 @@ module FusionAuth
|
|
2224
2110
|
#
|
2225
2111
|
# @param user_consent_id [string] The User consent Id
|
2226
2112
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2227
|
-
#
|
2228
2113
|
def retrieve_user_consent(user_consent_id)
|
2229
2114
|
start.uri('/api/user/consent')
|
2230
2115
|
.url_segment(user_consent_id)
|
@@ -2237,7 +2122,6 @@ module FusionAuth
|
|
2237
2122
|
#
|
2238
2123
|
# @param user_id [string] The User's Id
|
2239
2124
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2240
|
-
#
|
2241
2125
|
def retrieve_user_consents(user_id)
|
2242
2126
|
start.uri('/api/user/consent')
|
2243
2127
|
.url_parameter('userId', user_id)
|
@@ -2254,7 +2138,6 @@ module FusionAuth
|
|
2254
2138
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
2255
2139
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
2256
2140
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2257
|
-
#
|
2258
2141
|
def retrieve_user_login_report(application_id, user_id, start, _end)
|
2259
2142
|
start.uri('/api/report/login')
|
2260
2143
|
.url_parameter('applicationId', application_id)
|
@@ -2274,7 +2157,6 @@ module FusionAuth
|
|
2274
2157
|
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
|
2275
2158
|
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
|
2276
2159
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2277
|
-
#
|
2278
2160
|
def retrieve_user_login_report_by_login_id(application_id, login_id, start, _end)
|
2279
2161
|
start.uri('/api/report/login')
|
2280
2162
|
.url_parameter('applicationId', application_id)
|
@@ -2292,7 +2174,6 @@ module FusionAuth
|
|
2292
2174
|
# @param offset [Numeric] The initial record. e.g. 0 is the last login, 100 will be the 100th most recent login.
|
2293
2175
|
# @param limit [Numeric] (Optional, defaults to 10) The number of records to retrieve.
|
2294
2176
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2295
|
-
#
|
2296
2177
|
def retrieve_user_recent_logins(user_id, offset, limit)
|
2297
2178
|
start.uri('/api/user/recent-login')
|
2298
2179
|
.url_parameter('userId', user_id)
|
@@ -2307,7 +2188,6 @@ module FusionAuth
|
|
2307
2188
|
#
|
2308
2189
|
# @param encoded_jwt [string] The encoded JWT (access token).
|
2309
2190
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2310
|
-
#
|
2311
2191
|
def retrieve_user_using_jwt(encoded_jwt)
|
2312
2192
|
startAnonymous.uri('/api/user')
|
2313
2193
|
.authorization('JWT ' + encoded_jwt)
|
@@ -2320,7 +2200,6 @@ module FusionAuth
|
|
2320
2200
|
#
|
2321
2201
|
# @param webhook_id [string] (Optional) The Id of the webhook.
|
2322
2202
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2323
|
-
#
|
2324
2203
|
def retrieve_webhook(webhook_id)
|
2325
2204
|
start.uri('/api/webhook')
|
2326
2205
|
.url_segment(webhook_id)
|
@@ -2332,7 +2211,6 @@ module FusionAuth
|
|
2332
2211
|
# Retrieves all the webhooks.
|
2333
2212
|
#
|
2334
2213
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2335
|
-
#
|
2336
2214
|
def retrieve_webhooks()
|
2337
2215
|
start.uri('/api/webhook')
|
2338
2216
|
.get()
|
@@ -2347,7 +2225,6 @@ module FusionAuth
|
|
2347
2225
|
# @param user_id [string] (Optional) The user id whose tokens to delete.
|
2348
2226
|
# @param application_id [string] (Optional) The application id of the tokens to delete.
|
2349
2227
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2350
|
-
#
|
2351
2228
|
def revoke_refresh_token(token, user_id, application_id)
|
2352
2229
|
start.uri('/api/jwt/refresh')
|
2353
2230
|
.url_parameter('token', token)
|
@@ -2362,7 +2239,6 @@ module FusionAuth
|
|
2362
2239
|
#
|
2363
2240
|
# @param user_consent_id [string] The User Consent Id
|
2364
2241
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2365
|
-
#
|
2366
2242
|
def revoke_user_consent(user_consent_id)
|
2367
2243
|
start.uri('/api/user/consent')
|
2368
2244
|
.url_segment(user_consent_id)
|
@@ -2375,7 +2251,6 @@ module FusionAuth
|
|
2375
2251
|
#
|
2376
2252
|
# @param request [OpenStruct, Hash] The search criteria and pagination information.
|
2377
2253
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2378
|
-
#
|
2379
2254
|
def search_audit_logs(request)
|
2380
2255
|
start.uri('/api/system/audit-log/search')
|
2381
2256
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2388,7 +2263,6 @@ module FusionAuth
|
|
2388
2263
|
#
|
2389
2264
|
# @param request [OpenStruct, Hash] The search criteria and pagination information.
|
2390
2265
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2391
|
-
#
|
2392
2266
|
def search_event_logs(request)
|
2393
2267
|
start.uri('/api/system/event-log/search')
|
2394
2268
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2401,7 +2275,6 @@ module FusionAuth
|
|
2401
2275
|
#
|
2402
2276
|
# @param request [OpenStruct, Hash] The search criteria and pagination information.
|
2403
2277
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2404
|
-
#
|
2405
2278
|
def search_login_records(request)
|
2406
2279
|
start.uri('/api/system/login-record/search')
|
2407
2280
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2414,7 +2287,7 @@ module FusionAuth
|
|
2414
2287
|
#
|
2415
2288
|
# @param ids [Array] The user ids to search for.
|
2416
2289
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2417
|
-
#
|
2290
|
+
# @deprecated This method has been renamed to search_users_by_ids, use this method instead.
|
2418
2291
|
def search_users(ids)
|
2419
2292
|
start.uri('/api/user/search')
|
2420
2293
|
.url_parameter('ids', ids)
|
@@ -2422,13 +2295,38 @@ module FusionAuth
|
|
2422
2295
|
.go()
|
2423
2296
|
end
|
2424
2297
|
|
2298
|
+
#
|
2299
|
+
# Retrieves the users for the given ids. If any id is invalid, it is ignored.
|
2300
|
+
#
|
2301
|
+
# @param ids [Array] The user ids to search for.
|
2302
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2303
|
+
def search_users_by_ids(ids)
|
2304
|
+
start.uri('/api/user/search')
|
2305
|
+
.url_parameter('ids', ids)
|
2306
|
+
.get()
|
2307
|
+
.go()
|
2308
|
+
end
|
2309
|
+
|
2425
2310
|
#
|
2426
2311
|
# Retrieves the users for the given search criteria and pagination.
|
2427
2312
|
#
|
2428
|
-
# @param request [OpenStruct, Hash] The search criteria and pagination constraints. Fields used: queryString, numberOfResults, startRow,
|
2429
|
-
# and
|
2313
|
+
# @param request [OpenStruct, Hash] The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
|
2314
|
+
# and sortFields.
|
2430
2315
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2316
|
+
def search_users_by_query(request)
|
2317
|
+
start.uri('/api/user/search')
|
2318
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
2319
|
+
.post()
|
2320
|
+
.go()
|
2321
|
+
end
|
2322
|
+
|
2431
2323
|
#
|
2324
|
+
# Retrieves the users for the given search criteria and pagination.
|
2325
|
+
#
|
2326
|
+
# @param request [OpenStruct, Hash] The search criteria and pagination constraints. Fields used: ids, query, queryString, numberOfResults, orderBy, startRow,
|
2327
|
+
# and sortFields.
|
2328
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2329
|
+
# @deprecated This method has been renamed to search_users_by_query, use this method instead.
|
2432
2330
|
def search_users_by_query_string(request)
|
2433
2331
|
start.uri('/api/user/search')
|
2434
2332
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2443,7 +2341,6 @@ module FusionAuth
|
|
2443
2341
|
# @param email_template_id [string] The id for the template.
|
2444
2342
|
# @param request [OpenStruct, Hash] The send email request that contains all of the information used to send the email.
|
2445
2343
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2446
|
-
#
|
2447
2344
|
def send_email(email_template_id, request)
|
2448
2345
|
start.uri('/api/email/send')
|
2449
2346
|
.url_segment(email_template_id)
|
@@ -2457,7 +2354,6 @@ module FusionAuth
|
|
2457
2354
|
#
|
2458
2355
|
# @param request [OpenStruct, Hash] The request object that contains the parent email.
|
2459
2356
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2460
|
-
#
|
2461
2357
|
def send_family_request_email(request)
|
2462
2358
|
start.uri('/api/user/family/request')
|
2463
2359
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2470,7 +2366,6 @@ module FusionAuth
|
|
2470
2366
|
#
|
2471
2367
|
# @param request [OpenStruct, Hash] The passwordless send request that contains all of the information used to send an email containing a code.
|
2472
2368
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2473
|
-
#
|
2474
2369
|
def send_passwordless_code(request)
|
2475
2370
|
startAnonymous.uri('/api/passwordless/send')
|
2476
2371
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2483,7 +2378,6 @@ module FusionAuth
|
|
2483
2378
|
#
|
2484
2379
|
# @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code.
|
2485
2380
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2486
|
-
#
|
2487
2381
|
def send_two_factor_code(request)
|
2488
2382
|
start.uri('/api/two-factor/send')
|
2489
2383
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2496,7 +2390,6 @@ module FusionAuth
|
|
2496
2390
|
#
|
2497
2391
|
# @param two_factor_id [string] The Id returned by the Login API necessary to complete Two Factor authentication.
|
2498
2392
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2499
|
-
#
|
2500
2393
|
def send_two_factor_code_for_login(two_factor_id)
|
2501
2394
|
startAnonymous.uri('/api/two-factor/send')
|
2502
2395
|
.url_segment(two_factor_id)
|
@@ -2510,7 +2403,6 @@ module FusionAuth
|
|
2510
2403
|
# @param request [OpenStruct, Hash] The third-party login request that contains information from the third-party login
|
2511
2404
|
# providers that FusionAuth uses to reconcile the user's account.
|
2512
2405
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2513
|
-
#
|
2514
2406
|
def start_identity_provider_login(request)
|
2515
2407
|
start.uri('/api/identity-provider/start')
|
2516
2408
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2524,7 +2416,6 @@ module FusionAuth
|
|
2524
2416
|
#
|
2525
2417
|
# @param request [OpenStruct, Hash] The passwordless start request that contains all of the information used to begin the passwordless login request.
|
2526
2418
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2527
|
-
#
|
2528
2419
|
def start_passwordless_login(request)
|
2529
2420
|
start.uri('/api/passwordless/start')
|
2530
2421
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2537,7 +2428,6 @@ module FusionAuth
|
|
2537
2428
|
#
|
2538
2429
|
# @param request [OpenStruct, Hash] The login request that contains the user credentials used to log them in.
|
2539
2430
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2540
|
-
#
|
2541
2431
|
def two_factor_login(request)
|
2542
2432
|
startAnonymous.uri('/api/two-factor/login')
|
2543
2433
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2551,7 +2441,6 @@ module FusionAuth
|
|
2551
2441
|
# @param application_id [string] The Id of the application to update.
|
2552
2442
|
# @param request [OpenStruct, Hash] The request that contains all of the new application information.
|
2553
2443
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2554
|
-
#
|
2555
2444
|
def update_application(application_id, request)
|
2556
2445
|
start.uri('/api/application')
|
2557
2446
|
.url_segment(application_id)
|
@@ -2567,7 +2456,6 @@ module FusionAuth
|
|
2567
2456
|
# @param role_id [string] The Id of the role to update.
|
2568
2457
|
# @param request [OpenStruct, Hash] The request that contains all of the new role information.
|
2569
2458
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2570
|
-
#
|
2571
2459
|
def update_application_role(application_id, role_id, request)
|
2572
2460
|
start.uri('/api/application')
|
2573
2461
|
.url_segment(application_id)
|
@@ -2584,7 +2472,6 @@ module FusionAuth
|
|
2584
2472
|
# @param consent_id [string] The Id of the consent to update.
|
2585
2473
|
# @param request [OpenStruct, Hash] The request that contains all of the new consent information.
|
2586
2474
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2587
|
-
#
|
2588
2475
|
def update_consent(consent_id, request)
|
2589
2476
|
start.uri('/api/consent')
|
2590
2477
|
.url_segment(consent_id)
|
@@ -2599,7 +2486,6 @@ module FusionAuth
|
|
2599
2486
|
# @param email_template_id [string] The Id of the email template to update.
|
2600
2487
|
# @param request [OpenStruct, Hash] The request that contains all of the new email template information.
|
2601
2488
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2602
|
-
#
|
2603
2489
|
def update_email_template(email_template_id, request)
|
2604
2490
|
start.uri('/api/email/template')
|
2605
2491
|
.url_segment(email_template_id)
|
@@ -2614,7 +2500,6 @@ module FusionAuth
|
|
2614
2500
|
# @param group_id [string] The Id of the group to update.
|
2615
2501
|
# @param request [OpenStruct, Hash] The request that contains all of the new group information.
|
2616
2502
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2617
|
-
#
|
2618
2503
|
def update_group(group_id, request)
|
2619
2504
|
start.uri('/api/group')
|
2620
2505
|
.url_segment(group_id)
|
@@ -2629,7 +2514,6 @@ module FusionAuth
|
|
2629
2514
|
# @param identity_provider_id [string] The Id of the identity provider to update.
|
2630
2515
|
# @param request [OpenStruct, Hash] The request object that contains the updated identity provider.
|
2631
2516
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2632
|
-
#
|
2633
2517
|
def update_identity_provider(identity_provider_id, request)
|
2634
2518
|
start.uri('/api/identity-provider')
|
2635
2519
|
.url_segment(identity_provider_id)
|
@@ -2643,7 +2527,6 @@ module FusionAuth
|
|
2643
2527
|
#
|
2644
2528
|
# @param request [OpenStruct, Hash] The request that contains all of the new integration information.
|
2645
2529
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2646
|
-
#
|
2647
2530
|
def update_integrations(request)
|
2648
2531
|
start.uri('/api/integration')
|
2649
2532
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2657,7 +2540,6 @@ module FusionAuth
|
|
2657
2540
|
# @param key_id [string] The Id of the key to update.
|
2658
2541
|
# @param request [OpenStruct, Hash] The request that contains all of the new key information.
|
2659
2542
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2660
|
-
#
|
2661
2543
|
def update_key(key_id, request)
|
2662
2544
|
start.uri('/api/key')
|
2663
2545
|
.url_segment(key_id)
|
@@ -2672,7 +2554,6 @@ module FusionAuth
|
|
2672
2554
|
# @param lambda_id [string] The Id of the lambda to update.
|
2673
2555
|
# @param request [OpenStruct, Hash] The request that contains all of the new lambda information.
|
2674
2556
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2675
|
-
#
|
2676
2557
|
def update_lambda(lambda_id, request)
|
2677
2558
|
start.uri('/api/lambda')
|
2678
2559
|
.url_segment(lambda_id)
|
@@ -2687,7 +2568,6 @@ module FusionAuth
|
|
2687
2568
|
# @param user_id [string] The Id of the user whose registration is going to be updated.
|
2688
2569
|
# @param request [OpenStruct, Hash] The request that contains all of the new registration information.
|
2689
2570
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2690
|
-
#
|
2691
2571
|
def update_registration(user_id, request)
|
2692
2572
|
start.uri('/api/user/registration')
|
2693
2573
|
.url_segment(user_id)
|
@@ -2701,7 +2581,6 @@ module FusionAuth
|
|
2701
2581
|
#
|
2702
2582
|
# @param request [OpenStruct, Hash] The request that contains all of the new system configuration information.
|
2703
2583
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2704
|
-
#
|
2705
2584
|
def update_system_configuration(request)
|
2706
2585
|
start.uri('/api/system-configuration')
|
2707
2586
|
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
@@ -2715,7 +2594,6 @@ module FusionAuth
|
|
2715
2594
|
# @param tenant_id [string] The Id of the tenant to update.
|
2716
2595
|
# @param request [OpenStruct, Hash] The request that contains all of the new tenant information.
|
2717
2596
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2718
|
-
#
|
2719
2597
|
def update_tenant(tenant_id, request)
|
2720
2598
|
start.uri('/api/tenant')
|
2721
2599
|
.url_segment(tenant_id)
|
@@ -2730,7 +2608,6 @@ module FusionAuth
|
|
2730
2608
|
# @param theme_id [string] The Id of the theme to update.
|
2731
2609
|
# @param request [OpenStruct, Hash] The request that contains all of the new theme information.
|
2732
2610
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2733
|
-
#
|
2734
2611
|
def update_theme(theme_id, request)
|
2735
2612
|
start.uri('/api/theme')
|
2736
2613
|
.url_segment(theme_id)
|
@@ -2745,7 +2622,6 @@ module FusionAuth
|
|
2745
2622
|
# @param user_id [string] The Id of the user to update.
|
2746
2623
|
# @param request [OpenStruct, Hash] The request that contains all of the new user information.
|
2747
2624
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2748
|
-
#
|
2749
2625
|
def update_user(user_id, request)
|
2750
2626
|
start.uri('/api/user')
|
2751
2627
|
.url_segment(user_id)
|
@@ -2760,7 +2636,6 @@ module FusionAuth
|
|
2760
2636
|
# @param user_action_id [string] The Id of the user action to update.
|
2761
2637
|
# @param request [OpenStruct, Hash] The request that contains all of the new user action information.
|
2762
2638
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2763
|
-
#
|
2764
2639
|
def update_user_action(user_action_id, request)
|
2765
2640
|
start.uri('/api/user-action')
|
2766
2641
|
.url_segment(user_action_id)
|
@@ -2775,7 +2650,6 @@ module FusionAuth
|
|
2775
2650
|
# @param user_action_reason_id [string] The Id of the user action reason to update.
|
2776
2651
|
# @param request [OpenStruct, Hash] The request that contains all of the new user action reason information.
|
2777
2652
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2778
|
-
#
|
2779
2653
|
def update_user_action_reason(user_action_reason_id, request)
|
2780
2654
|
start.uri('/api/user-action-reason')
|
2781
2655
|
.url_segment(user_action_reason_id)
|
@@ -2790,7 +2664,6 @@ module FusionAuth
|
|
2790
2664
|
# @param user_consent_id [string] The User Consent Id
|
2791
2665
|
# @param request [OpenStruct, Hash] The request that contains the user consent information.
|
2792
2666
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2793
|
-
#
|
2794
2667
|
def update_user_consent(user_consent_id, request)
|
2795
2668
|
start.uri('/api/user/consent')
|
2796
2669
|
.url_segment(user_consent_id)
|
@@ -2805,7 +2678,6 @@ module FusionAuth
|
|
2805
2678
|
# @param webhook_id [string] The Id of the webhook to update.
|
2806
2679
|
# @param request [OpenStruct, Hash] The request that contains all of the new webhook information.
|
2807
2680
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2808
|
-
#
|
2809
2681
|
def update_webhook(webhook_id, request)
|
2810
2682
|
start.uri('/api/webhook')
|
2811
2683
|
.url_segment(webhook_id)
|
@@ -2821,7 +2693,6 @@ module FusionAuth
|
|
2821
2693
|
# @param user_code [string] The end-user verification code.
|
2822
2694
|
# @param client_id [string] The client id.
|
2823
2695
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2824
|
-
#
|
2825
2696
|
def validate_device(user_code, client_id)
|
2826
2697
|
startAnonymous.uri('/oauth2/device/validate')
|
2827
2698
|
.url_parameter('user_code', user_code)
|
@@ -2838,7 +2709,6 @@ module FusionAuth
|
|
2838
2709
|
#
|
2839
2710
|
# @param encoded_jwt [string] The encoded JWT (access token).
|
2840
2711
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2841
|
-
#
|
2842
2712
|
def validate_jwt(encoded_jwt)
|
2843
2713
|
startAnonymous.uri('/api/jwt/validate')
|
2844
2714
|
.authorization('JWT ' + encoded_jwt)
|
@@ -2851,7 +2721,6 @@ module FusionAuth
|
|
2851
2721
|
#
|
2852
2722
|
# @param verification_id [string] The email verification id sent to the user.
|
2853
2723
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2854
|
-
#
|
2855
2724
|
def verify_email(verification_id)
|
2856
2725
|
startAnonymous.uri('/api/user/verify-email')
|
2857
2726
|
.url_segment(verification_id)
|
@@ -2864,7 +2733,6 @@ module FusionAuth
|
|
2864
2733
|
#
|
2865
2734
|
# @param verification_id [string] The registration verification Id sent to the user.
|
2866
2735
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
2867
|
-
#
|
2868
2736
|
def verify_registration(verification_id)
|
2869
2737
|
startAnonymous.uri('/api/user/verify-registration')
|
2870
2738
|
.url_segment(verification_id)
|