fusionauth_client 1.52.0 → 1.54.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/build.savant +3 -3
- data/doc/FusionAuth/FusionAuthClient.html +205 -85
- data/doc/created.rid +2 -2
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +15 -0
- data/fusionauth_client.gemspec +1 -1
- data/lib/fusionauth/fusionauth_client.rb +36 -0
- metadata +2 -2
@@ -591,6 +591,10 @@
|
|
591
591
|
|
592
592
|
<li ><a href="#method-i-retrieve_webhook">#retrieve_webhook</a>
|
593
593
|
|
594
|
+
<li ><a href="#method-i-retrieve_webhook_attempt_log">#retrieve_webhook_attempt_log</a>
|
595
|
+
|
596
|
+
<li ><a href="#method-i-retrieve_webhook_event_log">#retrieve_webhook_event_log</a>
|
597
|
+
|
594
598
|
<li ><a href="#method-i-retrieve_webhooks">#retrieve_webhooks</a>
|
595
599
|
|
596
600
|
<li ><a href="#method-i-revoke_refresh_token">#revoke_refresh_token</a>
|
@@ -655,6 +659,8 @@
|
|
655
659
|
|
656
660
|
<li ><a href="#method-i-search_users_by_query_string">#search_users_by_query_string</a>
|
657
661
|
|
662
|
+
<li ><a href="#method-i-search_webhook_event_logs">#search_webhook_event_logs</a>
|
663
|
+
|
658
664
|
<li ><a href="#method-i-search_webhooks">#search_webhooks</a>
|
659
665
|
|
660
666
|
<li ><a href="#method-i-send_email">#send_email</a>
|
@@ -10932,6 +10938,82 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
10932
10938
|
|
10933
10939
|
|
10934
10940
|
|
10941
|
+
</div>
|
10942
|
+
|
10943
|
+
|
10944
|
+
<div id="method-i-retrieve_webhook_attempt_log" class="method-detail ">
|
10945
|
+
|
10946
|
+
<div class="method-heading">
|
10947
|
+
<span class="method-name">retrieve_webhook_attempt_log</span><span
|
10948
|
+
class="method-args">(webhook_attempt_log_id)</span>
|
10949
|
+
|
10950
|
+
<span class="method-click-advice">click to toggle source</span>
|
10951
|
+
|
10952
|
+
</div>
|
10953
|
+
|
10954
|
+
|
10955
|
+
<div class="method-description">
|
10956
|
+
|
10957
|
+
<p>Retrieves a single webhook attempt log for the given Id.</p>
|
10958
|
+
|
10959
|
+
<p>@param webhook_attempt_log_id [string] The Id of the webhook attempt log to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.</p>
|
10960
|
+
|
10961
|
+
|
10962
|
+
|
10963
|
+
|
10964
|
+
<div class="method-source-code" id="retrieve_webhook_attempt_log-source">
|
10965
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3546</span>
|
10966
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">retrieve_webhook_attempt_log</span>(<span class="ruby-identifier">webhook_attempt_log_id</span>)
|
10967
|
+
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/webhook-attempt-log'</span>)
|
10968
|
+
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">webhook_attempt_log_id</span>)
|
10969
|
+
.<span class="ruby-identifier">get</span>
|
10970
|
+
.<span class="ruby-identifier">go</span>
|
10971
|
+
<span class="ruby-keyword">end</span></pre>
|
10972
|
+
</div>
|
10973
|
+
|
10974
|
+
</div>
|
10975
|
+
|
10976
|
+
|
10977
|
+
|
10978
|
+
|
10979
|
+
</div>
|
10980
|
+
|
10981
|
+
|
10982
|
+
<div id="method-i-retrieve_webhook_event_log" class="method-detail ">
|
10983
|
+
|
10984
|
+
<div class="method-heading">
|
10985
|
+
<span class="method-name">retrieve_webhook_event_log</span><span
|
10986
|
+
class="method-args">(webhook_event_log_id)</span>
|
10987
|
+
|
10988
|
+
<span class="method-click-advice">click to toggle source</span>
|
10989
|
+
|
10990
|
+
</div>
|
10991
|
+
|
10992
|
+
|
10993
|
+
<div class="method-description">
|
10994
|
+
|
10995
|
+
<p>Retrieves a single webhook event log for the given Id.</p>
|
10996
|
+
|
10997
|
+
<p>@param webhook_event_log_id [string] The Id of the webhook event log to retrieve. @return [FusionAuth::ClientResponse] The ClientResponse object.</p>
|
10998
|
+
|
10999
|
+
|
11000
|
+
|
11001
|
+
|
11002
|
+
<div class="method-source-code" id="retrieve_webhook_event_log-source">
|
11003
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3558</span>
|
11004
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">retrieve_webhook_event_log</span>(<span class="ruby-identifier">webhook_event_log_id</span>)
|
11005
|
+
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/webhook-event-log'</span>)
|
11006
|
+
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">webhook_event_log_id</span>)
|
11007
|
+
.<span class="ruby-identifier">get</span>
|
11008
|
+
.<span class="ruby-identifier">go</span>
|
11009
|
+
<span class="ruby-keyword">end</span></pre>
|
11010
|
+
</div>
|
11011
|
+
|
11012
|
+
</div>
|
11013
|
+
|
11014
|
+
|
11015
|
+
|
11016
|
+
|
10935
11017
|
</div>
|
10936
11018
|
|
10937
11019
|
|
@@ -10956,7 +11038,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
10956
11038
|
|
10957
11039
|
|
10958
11040
|
<div class="method-source-code" id="retrieve_webhooks-source">
|
10959
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11041
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3569</span>
|
10960
11042
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">retrieve_webhooks</span>
|
10961
11043
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/webhook'</span>)
|
10962
11044
|
.<span class="ruby-identifier">get</span>
|
@@ -11018,7 +11100,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11018
11100
|
|
11019
11101
|
|
11020
11102
|
<div class="method-source-code" id="revoke_refresh_token-source">
|
11021
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11103
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3605</span>
|
11022
11104
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_token</span>(<span class="ruby-identifier">token</span>, <span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">application_id</span>)
|
11023
11105
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11024
11106
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'token'</span>, <span class="ruby-identifier">token</span>)
|
@@ -11058,7 +11140,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11058
11140
|
|
11059
11141
|
|
11060
11142
|
<div class="method-source-code" id="revoke_refresh_token_by_id-source">
|
11061
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11143
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3619</span>
|
11062
11144
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_token_by_id</span>(<span class="ruby-identifier">token_id</span>)
|
11063
11145
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11064
11146
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">token_id</span>)
|
@@ -11096,7 +11178,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11096
11178
|
|
11097
11179
|
|
11098
11180
|
<div class="method-source-code" id="revoke_refresh_token_by_token-source">
|
11099
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11181
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3631</span>
|
11100
11182
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_token_by_token</span>(<span class="ruby-identifier">token</span>)
|
11101
11183
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11102
11184
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'token'</span>, <span class="ruby-identifier">token</span>)
|
@@ -11134,7 +11216,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11134
11216
|
|
11135
11217
|
|
11136
11218
|
<div class="method-source-code" id="revoke_refresh_tokens_by_application_id-source">
|
11137
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11219
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3643</span>
|
11138
11220
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_tokens_by_application_id</span>(<span class="ruby-identifier">application_id</span>)
|
11139
11221
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11140
11222
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'applicationId'</span>, <span class="ruby-identifier">application_id</span>)
|
@@ -11172,7 +11254,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11172
11254
|
|
11173
11255
|
|
11174
11256
|
<div class="method-source-code" id="revoke_refresh_tokens_by_user_id-source">
|
11175
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11257
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3655</span>
|
11176
11258
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_tokens_by_user_id</span>(<span class="ruby-identifier">user_id</span>)
|
11177
11259
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11178
11260
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'userId'</span>, <span class="ruby-identifier">user_id</span>)
|
@@ -11210,7 +11292,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11210
11292
|
|
11211
11293
|
|
11212
11294
|
<div class="method-source-code" id="revoke_refresh_tokens_by_user_id_for_application-source">
|
11213
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11295
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3668</span>
|
11214
11296
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_tokens_by_user_id_for_application</span>(<span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">application_id</span>)
|
11215
11297
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11216
11298
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'userId'</span>, <span class="ruby-identifier">user_id</span>)
|
@@ -11249,7 +11331,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11249
11331
|
|
11250
11332
|
|
11251
11333
|
<div class="method-source-code" id="revoke_refresh_tokens_with_request-source">
|
11252
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11334
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3682</span>
|
11253
11335
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_refresh_tokens_with_request</span>(<span class="ruby-identifier">request</span>)
|
11254
11336
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/refresh'</span>)
|
11255
11337
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11287,7 +11369,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11287
11369
|
|
11288
11370
|
|
11289
11371
|
<div class="method-source-code" id="revoke_user_consent-source">
|
11290
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11372
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3694</span>
|
11291
11373
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">revoke_user_consent</span>(<span class="ruby-identifier">user_consent_id</span>)
|
11292
11374
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/consent'</span>)
|
11293
11375
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_consent_id</span>)
|
@@ -11325,7 +11407,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11325
11407
|
|
11326
11408
|
|
11327
11409
|
<div class="method-source-code" id="search_applications-source">
|
11328
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11410
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3706</span>
|
11329
11411
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_applications</span>(<span class="ruby-identifier">request</span>)
|
11330
11412
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/application/search'</span>)
|
11331
11413
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11363,7 +11445,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11363
11445
|
|
11364
11446
|
|
11365
11447
|
<div class="method-source-code" id="search_audit_logs-source">
|
11366
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11448
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3718</span>
|
11367
11449
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_audit_logs</span>(<span class="ruby-identifier">request</span>)
|
11368
11450
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/audit-log/search'</span>)
|
11369
11451
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11401,7 +11483,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11401
11483
|
|
11402
11484
|
|
11403
11485
|
<div class="method-source-code" id="search_consents-source">
|
11404
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11486
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3730</span>
|
11405
11487
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_consents</span>(<span class="ruby-identifier">request</span>)
|
11406
11488
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/consent/search'</span>)
|
11407
11489
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11439,7 +11521,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11439
11521
|
|
11440
11522
|
|
11441
11523
|
<div class="method-source-code" id="search_email_templates-source">
|
11442
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11524
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3742</span>
|
11443
11525
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_email_templates</span>(<span class="ruby-identifier">request</span>)
|
11444
11526
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/email/template/search'</span>)
|
11445
11527
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11477,7 +11559,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11477
11559
|
|
11478
11560
|
|
11479
11561
|
<div class="method-source-code" id="search_entities-source">
|
11480
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11562
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3754</span>
|
11481
11563
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_entities</span>(<span class="ruby-identifier">request</span>)
|
11482
11564
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/search'</span>)
|
11483
11565
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11515,7 +11597,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11515
11597
|
|
11516
11598
|
|
11517
11599
|
<div class="method-source-code" id="search_entities_by_ids-source">
|
11518
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11600
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3766</span>
|
11519
11601
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_entities_by_ids</span>(<span class="ruby-identifier">ids</span>)
|
11520
11602
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/search'</span>)
|
11521
11603
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'ids'</span>, <span class="ruby-identifier">ids</span>)
|
@@ -11553,7 +11635,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11553
11635
|
|
11554
11636
|
|
11555
11637
|
<div class="method-source-code" id="search_entity_grants-source">
|
11556
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11638
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3778</span>
|
11557
11639
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_entity_grants</span>(<span class="ruby-identifier">request</span>)
|
11558
11640
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/grant/search'</span>)
|
11559
11641
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11591,7 +11673,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11591
11673
|
|
11592
11674
|
|
11593
11675
|
<div class="method-source-code" id="search_entity_types-source">
|
11594
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11676
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3790</span>
|
11595
11677
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_entity_types</span>(<span class="ruby-identifier">request</span>)
|
11596
11678
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/type/search'</span>)
|
11597
11679
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11629,7 +11711,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11629
11711
|
|
11630
11712
|
|
11631
11713
|
<div class="method-source-code" id="search_event_logs-source">
|
11632
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11714
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3802</span>
|
11633
11715
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_event_logs</span>(<span class="ruby-identifier">request</span>)
|
11634
11716
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/event-log/search'</span>)
|
11635
11717
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11667,7 +11749,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11667
11749
|
|
11668
11750
|
|
11669
11751
|
<div class="method-source-code" id="search_group_members-source">
|
11670
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11752
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3814</span>
|
11671
11753
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_group_members</span>(<span class="ruby-identifier">request</span>)
|
11672
11754
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/group/member/search'</span>)
|
11673
11755
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11705,7 +11787,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11705
11787
|
|
11706
11788
|
|
11707
11789
|
<div class="method-source-code" id="search_groups-source">
|
11708
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11790
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3826</span>
|
11709
11791
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_groups</span>(<span class="ruby-identifier">request</span>)
|
11710
11792
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/group/search'</span>)
|
11711
11793
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11743,7 +11825,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11743
11825
|
|
11744
11826
|
|
11745
11827
|
<div class="method-source-code" id="search_identity_providers-source">
|
11746
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11828
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3850</span>
|
11747
11829
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_identity_providers</span>(<span class="ruby-identifier">request</span>)
|
11748
11830
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/identity-provider/search'</span>)
|
11749
11831
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11781,7 +11863,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11781
11863
|
|
11782
11864
|
|
11783
11865
|
<div class="method-source-code" id="search_ip_access_control_lists-source">
|
11784
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11866
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3838</span>
|
11785
11867
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_ip_access_control_lists</span>(<span class="ruby-identifier">request</span>)
|
11786
11868
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/ip-acl/search'</span>)
|
11787
11869
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11819,7 +11901,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11819
11901
|
|
11820
11902
|
|
11821
11903
|
<div class="method-source-code" id="search_keys-source">
|
11822
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11904
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3862</span>
|
11823
11905
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_keys</span>(<span class="ruby-identifier">request</span>)
|
11824
11906
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/key/search'</span>)
|
11825
11907
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11857,7 +11939,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11857
11939
|
|
11858
11940
|
|
11859
11941
|
<div class="method-source-code" id="search_lambdas-source">
|
11860
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11942
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3874</span>
|
11861
11943
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_lambdas</span>(<span class="ruby-identifier">request</span>)
|
11862
11944
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/lambda/search'</span>)
|
11863
11945
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11895,7 +11977,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11895
11977
|
|
11896
11978
|
|
11897
11979
|
<div class="method-source-code" id="search_login_records-source">
|
11898
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
11980
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3886</span>
|
11899
11981
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_login_records</span>(<span class="ruby-identifier">request</span>)
|
11900
11982
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/login-record/search'</span>)
|
11901
11983
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11933,7 +12015,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11933
12015
|
|
11934
12016
|
|
11935
12017
|
<div class="method-source-code" id="search_tenants-source">
|
11936
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12018
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3898</span>
|
11937
12019
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_tenants</span>(<span class="ruby-identifier">request</span>)
|
11938
12020
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/tenant/search'</span>)
|
11939
12021
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -11971,7 +12053,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
11971
12053
|
|
11972
12054
|
|
11973
12055
|
<div class="method-source-code" id="search_themes-source">
|
11974
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12056
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3910</span>
|
11975
12057
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_themes</span>(<span class="ruby-identifier">request</span>)
|
11976
12058
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/theme/search'</span>)
|
11977
12059
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12009,7 +12091,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12009
12091
|
|
12010
12092
|
|
12011
12093
|
<div class="method-source-code" id="search_user_comments-source">
|
12012
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12094
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3922</span>
|
12013
12095
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_user_comments</span>(<span class="ruby-identifier">request</span>)
|
12014
12096
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/comment/search'</span>)
|
12015
12097
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12047,7 +12129,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12047
12129
|
|
12048
12130
|
|
12049
12131
|
<div class="method-source-code" id="search_users-source">
|
12050
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12132
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3935</span>
|
12051
12133
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_users</span>(<span class="ruby-identifier">ids</span>)
|
12052
12134
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/search'</span>)
|
12053
12135
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'ids'</span>, <span class="ruby-identifier">ids</span>)
|
@@ -12085,7 +12167,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12085
12167
|
|
12086
12168
|
|
12087
12169
|
<div class="method-source-code" id="search_users_by_ids-source">
|
12088
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12170
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3947</span>
|
12089
12171
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_users_by_ids</span>(<span class="ruby-identifier">ids</span>)
|
12090
12172
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/search'</span>)
|
12091
12173
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'ids'</span>, <span class="ruby-identifier">ids</span>)
|
@@ -12127,7 +12209,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12127
12209
|
|
12128
12210
|
|
12129
12211
|
<div class="method-source-code" id="search_users_by_query-source">
|
12130
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12212
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3960</span>
|
12131
12213
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_users_by_query</span>(<span class="ruby-identifier">request</span>)
|
12132
12214
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/search'</span>)
|
12133
12215
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12169,7 +12251,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12169
12251
|
|
12170
12252
|
|
12171
12253
|
<div class="method-source-code" id="search_users_by_query_string-source">
|
12172
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12254
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3974</span>
|
12173
12255
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_users_by_query_string</span>(<span class="ruby-identifier">request</span>)
|
12174
12256
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/search'</span>)
|
12175
12257
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12183,6 +12265,44 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12183
12265
|
|
12184
12266
|
|
12185
12267
|
|
12268
|
+
</div>
|
12269
|
+
|
12270
|
+
|
12271
|
+
<div id="method-i-search_webhook_event_logs" class="method-detail ">
|
12272
|
+
|
12273
|
+
<div class="method-heading">
|
12274
|
+
<span class="method-name">search_webhook_event_logs</span><span
|
12275
|
+
class="method-args">(request)</span>
|
12276
|
+
|
12277
|
+
<span class="method-click-advice">click to toggle source</span>
|
12278
|
+
|
12279
|
+
</div>
|
12280
|
+
|
12281
|
+
|
12282
|
+
<div class="method-description">
|
12283
|
+
|
12284
|
+
<p>Searches the webhook event logs with the specified criteria and pagination.</p>
|
12285
|
+
|
12286
|
+
<p>@param request [OpenStruct, Hash] The search criteria and pagination information. @return [FusionAuth::ClientResponse] The ClientResponse object.</p>
|
12287
|
+
|
12288
|
+
|
12289
|
+
|
12290
|
+
|
12291
|
+
<div class="method-source-code" id="search_webhook_event_logs-source">
|
12292
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3986</span>
|
12293
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_webhook_event_logs</span>(<span class="ruby-identifier">request</span>)
|
12294
|
+
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system/webhook-event-log/search'</span>)
|
12295
|
+
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
12296
|
+
.<span class="ruby-identifier">post</span>
|
12297
|
+
.<span class="ruby-identifier">go</span>
|
12298
|
+
<span class="ruby-keyword">end</span></pre>
|
12299
|
+
</div>
|
12300
|
+
|
12301
|
+
</div>
|
12302
|
+
|
12303
|
+
|
12304
|
+
|
12305
|
+
|
12186
12306
|
</div>
|
12187
12307
|
|
12188
12308
|
|
@@ -12207,7 +12327,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12207
12327
|
|
12208
12328
|
|
12209
12329
|
<div class="method-source-code" id="search_webhooks-source">
|
12210
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12330
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 3998</span>
|
12211
12331
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_webhooks</span>(<span class="ruby-identifier">request</span>)
|
12212
12332
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/webhook/search'</span>)
|
12213
12333
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12245,7 +12365,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12245
12365
|
|
12246
12366
|
|
12247
12367
|
<div class="method-source-code" id="send_email-source">
|
12248
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12368
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4012</span>
|
12249
12369
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_email</span>(<span class="ruby-identifier">email_template_id</span>, <span class="ruby-identifier">request</span>)
|
12250
12370
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/email/send'</span>)
|
12251
12371
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">email_template_id</span>)
|
@@ -12284,7 +12404,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12284
12404
|
|
12285
12405
|
|
12286
12406
|
<div class="method-source-code" id="send_family_request_email-source">
|
12287
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12407
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4025</span>
|
12288
12408
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_family_request_email</span>(<span class="ruby-identifier">request</span>)
|
12289
12409
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/family/request'</span>)
|
12290
12410
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12322,7 +12442,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12322
12442
|
|
12323
12443
|
|
12324
12444
|
<div class="method-source-code" id="send_passwordless_code-source">
|
12325
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12445
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4037</span>
|
12326
12446
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_passwordless_code</span>(<span class="ruby-identifier">request</span>)
|
12327
12447
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/passwordless/send'</span>)
|
12328
12448
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12360,7 +12480,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12360
12480
|
|
12361
12481
|
|
12362
12482
|
<div class="method-source-code" id="send_two_factor_code-source">
|
12363
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12483
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4050</span>
|
12364
12484
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_two_factor_code</span>(<span class="ruby-identifier">request</span>)
|
12365
12485
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/send'</span>)
|
12366
12486
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12398,7 +12518,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12398
12518
|
|
12399
12519
|
|
12400
12520
|
<div class="method-source-code" id="send_two_factor_code_for_enable_disable-source">
|
12401
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12521
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4062</span>
|
12402
12522
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_two_factor_code_for_enable_disable</span>(<span class="ruby-identifier">request</span>)
|
12403
12523
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/send'</span>)
|
12404
12524
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12436,7 +12556,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12436
12556
|
|
12437
12557
|
|
12438
12558
|
<div class="method-source-code" id="send_two_factor_code_for_login-source">
|
12439
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12559
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4075</span>
|
12440
12560
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_two_factor_code_for_login</span>(<span class="ruby-identifier">two_factor_id</span>)
|
12441
12561
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/send'</span>)
|
12442
12562
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">two_factor_id</span>)
|
@@ -12474,7 +12594,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12474
12594
|
|
12475
12595
|
|
12476
12596
|
<div class="method-source-code" id="send_two_factor_code_for_login_using_method-source">
|
12477
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12597
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4088</span>
|
12478
12598
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_two_factor_code_for_login_using_method</span>(<span class="ruby-identifier">two_factor_id</span>, <span class="ruby-identifier">request</span>)
|
12479
12599
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/send'</span>)
|
12480
12600
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">two_factor_id</span>)
|
@@ -12550,7 +12670,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12550
12670
|
|
12551
12671
|
|
12552
12672
|
<div class="method-source-code" id="start_identity_provider_login-source">
|
12553
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12673
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4102</span>
|
12554
12674
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_identity_provider_login</span>(<span class="ruby-identifier">request</span>)
|
12555
12675
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/identity-provider/start'</span>)
|
12556
12676
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12588,7 +12708,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12588
12708
|
|
12589
12709
|
|
12590
12710
|
<div class="method-source-code" id="start_passwordless_login-source">
|
12591
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12711
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4115</span>
|
12592
12712
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_passwordless_login</span>(<span class="ruby-identifier">request</span>)
|
12593
12713
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/passwordless/start'</span>)
|
12594
12714
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12628,7 +12748,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12628
12748
|
|
12629
12749
|
|
12630
12750
|
<div class="method-source-code" id="start_two_factor_login-source">
|
12631
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12751
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4132</span>
|
12632
12752
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_two_factor_login</span>(<span class="ruby-identifier">request</span>)
|
12633
12753
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/start'</span>)
|
12634
12754
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12666,7 +12786,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12666
12786
|
|
12667
12787
|
|
12668
12788
|
<div class="method-source-code" id="start_web_authn_login-source">
|
12669
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12789
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4144</span>
|
12670
12790
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_web_authn_login</span>(<span class="ruby-identifier">request</span>)
|
12671
12791
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/webauthn/start'</span>)
|
12672
12792
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12704,7 +12824,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12704
12824
|
|
12705
12825
|
|
12706
12826
|
<div class="method-source-code" id="start_web_authn_registration-source">
|
12707
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12827
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4156</span>
|
12708
12828
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_web_authn_registration</span>(<span class="ruby-identifier">request</span>)
|
12709
12829
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/webauthn/register/start'</span>)
|
12710
12830
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12742,7 +12862,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12742
12862
|
|
12743
12863
|
|
12744
12864
|
<div class="method-source-code" id="two_factor_login-source">
|
12745
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12865
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4168</span>
|
12746
12866
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">two_factor_login</span>(<span class="ruby-identifier">request</span>)
|
12747
12867
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/two-factor/login'</span>)
|
12748
12868
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -12780,7 +12900,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12780
12900
|
|
12781
12901
|
|
12782
12902
|
<div class="method-source-code" id="update_api_key-source">
|
12783
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12903
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4181</span>
|
12784
12904
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_api_key</span>(<span class="ruby-identifier">api_key_id</span>, <span class="ruby-identifier">request</span>)
|
12785
12905
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/api-key'</span>)
|
12786
12906
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">api_key_id</span>)
|
@@ -12819,7 +12939,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12819
12939
|
|
12820
12940
|
|
12821
12941
|
<div class="method-source-code" id="update_application-source">
|
12822
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12942
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4195</span>
|
12823
12943
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_application</span>(<span class="ruby-identifier">application_id</span>, <span class="ruby-identifier">request</span>)
|
12824
12944
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/application'</span>)
|
12825
12945
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">application_id</span>)
|
@@ -12858,7 +12978,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12858
12978
|
|
12859
12979
|
|
12860
12980
|
<div class="method-source-code" id="update_application_role-source">
|
12861
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
12981
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4210</span>
|
12862
12982
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_application_role</span>(<span class="ruby-identifier">application_id</span>, <span class="ruby-identifier">role_id</span>, <span class="ruby-identifier">request</span>)
|
12863
12983
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/application'</span>)
|
12864
12984
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">application_id</span>)
|
@@ -12899,7 +13019,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12899
13019
|
|
12900
13020
|
|
12901
13021
|
<div class="method-source-code" id="update_connector-source">
|
12902
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13022
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4226</span>
|
12903
13023
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_connector</span>(<span class="ruby-identifier">connector_id</span>, <span class="ruby-identifier">request</span>)
|
12904
13024
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/connector'</span>)
|
12905
13025
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">connector_id</span>)
|
@@ -12938,7 +13058,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12938
13058
|
|
12939
13059
|
|
12940
13060
|
<div class="method-source-code" id="update_consent-source">
|
12941
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13061
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4240</span>
|
12942
13062
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_consent</span>(<span class="ruby-identifier">consent_id</span>, <span class="ruby-identifier">request</span>)
|
12943
13063
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/consent'</span>)
|
12944
13064
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">consent_id</span>)
|
@@ -12977,7 +13097,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
12977
13097
|
|
12978
13098
|
|
12979
13099
|
<div class="method-source-code" id="update_email_template-source">
|
12980
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13100
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4254</span>
|
12981
13101
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_email_template</span>(<span class="ruby-identifier">email_template_id</span>, <span class="ruby-identifier">request</span>)
|
12982
13102
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/email/template'</span>)
|
12983
13103
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">email_template_id</span>)
|
@@ -13016,7 +13136,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13016
13136
|
|
13017
13137
|
|
13018
13138
|
<div class="method-source-code" id="update_entity-source">
|
13019
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13139
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4268</span>
|
13020
13140
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_entity</span>(<span class="ruby-identifier">entity_id</span>, <span class="ruby-identifier">request</span>)
|
13021
13141
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity'</span>)
|
13022
13142
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">entity_id</span>)
|
@@ -13055,7 +13175,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13055
13175
|
|
13056
13176
|
|
13057
13177
|
<div class="method-source-code" id="update_entity_type-source">
|
13058
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13178
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4282</span>
|
13059
13179
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_entity_type</span>(<span class="ruby-identifier">entity_type_id</span>, <span class="ruby-identifier">request</span>)
|
13060
13180
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/type'</span>)
|
13061
13181
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">entity_type_id</span>)
|
@@ -13094,7 +13214,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13094
13214
|
|
13095
13215
|
|
13096
13216
|
<div class="method-source-code" id="update_entity_type_permission-source">
|
13097
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13217
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4297</span>
|
13098
13218
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_entity_type_permission</span>(<span class="ruby-identifier">entity_type_id</span>, <span class="ruby-identifier">permission_id</span>, <span class="ruby-identifier">request</span>)
|
13099
13219
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity/type'</span>)
|
13100
13220
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">entity_type_id</span>)
|
@@ -13135,7 +13255,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13135
13255
|
|
13136
13256
|
|
13137
13257
|
<div class="method-source-code" id="update_form-source">
|
13138
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13258
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4313</span>
|
13139
13259
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_form</span>(<span class="ruby-identifier">form_id</span>, <span class="ruby-identifier">request</span>)
|
13140
13260
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/form'</span>)
|
13141
13261
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">form_id</span>)
|
@@ -13174,7 +13294,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13174
13294
|
|
13175
13295
|
|
13176
13296
|
<div class="method-source-code" id="update_form_field-source">
|
13177
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13297
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4327</span>
|
13178
13298
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_form_field</span>(<span class="ruby-identifier">field_id</span>, <span class="ruby-identifier">request</span>)
|
13179
13299
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/form/field'</span>)
|
13180
13300
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">field_id</span>)
|
@@ -13213,7 +13333,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13213
13333
|
|
13214
13334
|
|
13215
13335
|
<div class="method-source-code" id="update_group-source">
|
13216
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13336
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4341</span>
|
13217
13337
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_group</span>(<span class="ruby-identifier">group_id</span>, <span class="ruby-identifier">request</span>)
|
13218
13338
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/group'</span>)
|
13219
13339
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">group_id</span>)
|
@@ -13252,7 +13372,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13252
13372
|
|
13253
13373
|
|
13254
13374
|
<div class="method-source-code" id="update_group_members-source">
|
13255
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13375
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4354</span>
|
13256
13376
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_group_members</span>(<span class="ruby-identifier">request</span>)
|
13257
13377
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/group/member'</span>)
|
13258
13378
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -13290,7 +13410,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13290
13410
|
|
13291
13411
|
|
13292
13412
|
<div class="method-source-code" id="update_identity_provider-source">
|
13293
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13413
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4381</span>
|
13294
13414
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_identity_provider</span>(<span class="ruby-identifier">identity_provider_id</span>, <span class="ruby-identifier">request</span>)
|
13295
13415
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/identity-provider'</span>)
|
13296
13416
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">identity_provider_id</span>)
|
@@ -13329,7 +13449,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13329
13449
|
|
13330
13450
|
|
13331
13451
|
<div class="method-source-code" id="update_integrations-source">
|
13332
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13452
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4394</span>
|
13333
13453
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_integrations</span>(<span class="ruby-identifier">request</span>)
|
13334
13454
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/integration'</span>)
|
13335
13455
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -13367,7 +13487,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13367
13487
|
|
13368
13488
|
|
13369
13489
|
<div class="method-source-code" id="update_ip_access_control_list-source">
|
13370
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13490
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4367</span>
|
13371
13491
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_ip_access_control_list</span>(<span class="ruby-identifier">access_control_list_id</span>, <span class="ruby-identifier">request</span>)
|
13372
13492
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/ip-acl'</span>)
|
13373
13493
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">access_control_list_id</span>)
|
@@ -13406,7 +13526,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13406
13526
|
|
13407
13527
|
|
13408
13528
|
<div class="method-source-code" id="update_key-source">
|
13409
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13529
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4407</span>
|
13410
13530
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_key</span>(<span class="ruby-identifier">key_id</span>, <span class="ruby-identifier">request</span>)
|
13411
13531
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/key'</span>)
|
13412
13532
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">key_id</span>)
|
@@ -13445,7 +13565,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13445
13565
|
|
13446
13566
|
|
13447
13567
|
<div class="method-source-code" id="update_lambda-source">
|
13448
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13568
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4421</span>
|
13449
13569
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_lambda</span>(<span class="ruby-identifier">lambda_id</span>, <span class="ruby-identifier">request</span>)
|
13450
13570
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/lambda'</span>)
|
13451
13571
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">lambda_id</span>)
|
@@ -13484,7 +13604,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13484
13604
|
|
13485
13605
|
|
13486
13606
|
<div class="method-source-code" id="update_message_template-source">
|
13487
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13607
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4435</span>
|
13488
13608
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_message_template</span>(<span class="ruby-identifier">message_template_id</span>, <span class="ruby-identifier">request</span>)
|
13489
13609
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/message/template'</span>)
|
13490
13610
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">message_template_id</span>)
|
@@ -13523,7 +13643,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13523
13643
|
|
13524
13644
|
|
13525
13645
|
<div class="method-source-code" id="update_messenger-source">
|
13526
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13646
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4449</span>
|
13527
13647
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_messenger</span>(<span class="ruby-identifier">messenger_id</span>, <span class="ruby-identifier">request</span>)
|
13528
13648
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/messenger'</span>)
|
13529
13649
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">messenger_id</span>)
|
@@ -13562,7 +13682,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13562
13682
|
|
13563
13683
|
|
13564
13684
|
<div class="method-source-code" id="update_o_auth_scope-source">
|
13565
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13685
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4464</span>
|
13566
13686
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_o_auth_scope</span>(<span class="ruby-identifier">application_id</span>, <span class="ruby-identifier">scope_id</span>, <span class="ruby-identifier">request</span>)
|
13567
13687
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/application'</span>)
|
13568
13688
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">application_id</span>)
|
@@ -13603,7 +13723,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13603
13723
|
|
13604
13724
|
|
13605
13725
|
<div class="method-source-code" id="update_registration-source">
|
13606
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13726
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4480</span>
|
13607
13727
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_registration</span>(<span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">request</span>)
|
13608
13728
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/registration'</span>)
|
13609
13729
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_id</span>)
|
@@ -13642,7 +13762,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13642
13762
|
|
13643
13763
|
|
13644
13764
|
<div class="method-source-code" id="update_system_configuration-source">
|
13645
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13765
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4493</span>
|
13646
13766
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_system_configuration</span>(<span class="ruby-identifier">request</span>)
|
13647
13767
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/system-configuration'</span>)
|
13648
13768
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -13680,7 +13800,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13680
13800
|
|
13681
13801
|
|
13682
13802
|
<div class="method-source-code" id="update_tenant-source">
|
13683
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13803
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4506</span>
|
13684
13804
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_tenant</span>(<span class="ruby-identifier">tenant_id</span>, <span class="ruby-identifier">request</span>)
|
13685
13805
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/tenant'</span>)
|
13686
13806
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">tenant_id</span>)
|
@@ -13719,7 +13839,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13719
13839
|
|
13720
13840
|
|
13721
13841
|
<div class="method-source-code" id="update_theme-source">
|
13722
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13842
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4520</span>
|
13723
13843
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_theme</span>(<span class="ruby-identifier">theme_id</span>, <span class="ruby-identifier">request</span>)
|
13724
13844
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/theme'</span>)
|
13725
13845
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">theme_id</span>)
|
@@ -13758,7 +13878,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13758
13878
|
|
13759
13879
|
|
13760
13880
|
<div class="method-source-code" id="update_user-source">
|
13761
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13881
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4534</span>
|
13762
13882
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_user</span>(<span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">request</span>)
|
13763
13883
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user'</span>)
|
13764
13884
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_id</span>)
|
@@ -13797,7 +13917,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13797
13917
|
|
13798
13918
|
|
13799
13919
|
<div class="method-source-code" id="update_user_action-source">
|
13800
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13920
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4548</span>
|
13801
13921
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_user_action</span>(<span class="ruby-identifier">user_action_id</span>, <span class="ruby-identifier">request</span>)
|
13802
13922
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user-action'</span>)
|
13803
13923
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_action_id</span>)
|
@@ -13836,7 +13956,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13836
13956
|
|
13837
13957
|
|
13838
13958
|
<div class="method-source-code" id="update_user_action_reason-source">
|
13839
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13959
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4562</span>
|
13840
13960
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_user_action_reason</span>(<span class="ruby-identifier">user_action_reason_id</span>, <span class="ruby-identifier">request</span>)
|
13841
13961
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user-action-reason'</span>)
|
13842
13962
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_action_reason_id</span>)
|
@@ -13875,7 +13995,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13875
13995
|
|
13876
13996
|
|
13877
13997
|
<div class="method-source-code" id="update_user_consent-source">
|
13878
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
13998
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4576</span>
|
13879
13999
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_user_consent</span>(<span class="ruby-identifier">user_consent_id</span>, <span class="ruby-identifier">request</span>)
|
13880
14000
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/consent'</span>)
|
13881
14001
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">user_consent_id</span>)
|
@@ -13914,7 +14034,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13914
14034
|
|
13915
14035
|
|
13916
14036
|
<div class="method-source-code" id="update_webhook-source">
|
13917
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14037
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4590</span>
|
13918
14038
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_webhook</span>(<span class="ruby-identifier">webhook_id</span>, <span class="ruby-identifier">request</span>)
|
13919
14039
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/webhook'</span>)
|
13920
14040
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">webhook_id</span>)
|
@@ -13953,7 +14073,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13953
14073
|
|
13954
14074
|
|
13955
14075
|
<div class="method-source-code" id="upsert_entity_grant-source">
|
13956
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14076
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4604</span>
|
13957
14077
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">upsert_entity_grant</span>(<span class="ruby-identifier">entity_id</span>, <span class="ruby-identifier">request</span>)
|
13958
14078
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/entity'</span>)
|
13959
14079
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">entity_id</span>)
|
@@ -13993,7 +14113,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
13993
14113
|
|
13994
14114
|
|
13995
14115
|
<div class="method-source-code" id="validate_device-source">
|
13996
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14116
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4620</span>
|
13997
14117
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate_device</span>(<span class="ruby-identifier">user_code</span>, <span class="ruby-identifier">client_id</span>)
|
13998
14118
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/oauth2/device/validate'</span>)
|
13999
14119
|
.<span class="ruby-identifier">url_parameter</span>(<span class="ruby-string">'user_code'</span>, <span class="ruby-identifier">user_code</span>)
|
@@ -14032,7 +14152,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14032
14152
|
|
14033
14153
|
|
14034
14154
|
<div class="method-source-code" id="validate_jwt-source">
|
14035
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14155
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4636</span>
|
14036
14156
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate_jwt</span>(<span class="ruby-identifier">encoded_jwt</span>)
|
14037
14157
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/validate'</span>)
|
14038
14158
|
.<span class="ruby-identifier">authorization</span>(<span class="ruby-string">'Bearer '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">encoded_jwt</span>)
|
@@ -14074,7 +14194,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14074
14194
|
|
14075
14195
|
|
14076
14196
|
<div class="method-source-code" id="vend_jwt-source">
|
14077
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14197
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4656</span>
|
14078
14198
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">vend_jwt</span>(<span class="ruby-identifier">request</span>)
|
14079
14199
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/jwt/vend'</span>)
|
14080
14200
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -14112,7 +14232,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14112
14232
|
|
14113
14233
|
|
14114
14234
|
<div class="method-source-code" id="verify_email-source">
|
14115
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14235
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4669</span>
|
14116
14236
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_email</span>(<span class="ruby-identifier">verification_id</span>)
|
14117
14237
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/verify-email'</span>)
|
14118
14238
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">verification_id</span>)
|
@@ -14152,7 +14272,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14152
14272
|
|
14153
14273
|
|
14154
14274
|
<div class="method-source-code" id="verify_email_address-source">
|
14155
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14275
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4686</span>
|
14156
14276
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_email_address</span>(<span class="ruby-identifier">request</span>)
|
14157
14277
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/verify-email'</span>)
|
14158
14278
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -14192,7 +14312,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14192
14312
|
|
14193
14313
|
|
14194
14314
|
<div class="method-source-code" id="verify_email_address_by_user_id-source">
|
14195
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14315
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4700</span>
|
14196
14316
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_email_address_by_user_id</span>(<span class="ruby-identifier">request</span>)
|
14197
14317
|
<span class="ruby-identifier">start</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/verify-email'</span>)
|
14198
14318
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|
@@ -14230,7 +14350,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14230
14350
|
|
14231
14351
|
|
14232
14352
|
<div class="method-source-code" id="verify_registration-source">
|
14233
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14353
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4713</span>
|
14234
14354
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_registration</span>(<span class="ruby-identifier">verification_id</span>)
|
14235
14355
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/verify-registration'</span>)
|
14236
14356
|
.<span class="ruby-identifier">url_segment</span>(<span class="ruby-identifier">verification_id</span>)
|
@@ -14270,7 +14390,7 @@ tokens enabled in order to receive a refresh token in the response.</p></p
|
|
14270
14390
|
|
14271
14391
|
|
14272
14392
|
<div class="method-source-code" id="verify_user_registration-source">
|
14273
|
-
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line
|
14393
|
+
<pre><span class="ruby-comment"># File lib/fusionauth/fusionauth_client.rb, line 4730</span>
|
14274
14394
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_user_registration</span>(<span class="ruby-identifier">request</span>)
|
14275
14395
|
<span class="ruby-identifier">startAnonymous</span>.<span class="ruby-identifier">uri</span>(<span class="ruby-string">'/api/user/verify-registration'</span>)
|
14276
14396
|
.<span class="ruby-identifier">body_handler</span>(<span class="ruby-constant">FusionAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">JSONBodyHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>))
|