fusionauth_client 1.32.1 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b1f6d531e4e5184bbd5294048ff77fb7e2733a2caa8ababc38b4b986d03d6344
4
- data.tar.gz: 503df19d88f172e051b897b36a90b1620df27b57a6c88d7697704f0e4eddbd1c
3
+ metadata.gz: 8f821148b188a2af1ed2e36d1c24b0fdae610792f4ebabe404e226bd6964d451
4
+ data.tar.gz: a98b63e213361a0f0f7d759ca14294b8350596c9f8c27107baaf6ba1a4c36107
5
5
  SHA512:
6
- metadata.gz: 20ca95b8a9327581ca7efea9a9edddfd9792d7c7c23e4fa4721346c7e4f4c15502e8c66cebe80a386983210632317a639b0a66233283f61f6005b4dab2518562
7
- data.tar.gz: 36e430cba9606e9bdc57d6138457ceeeed18ae69b65590338e9d5ccbc56969c31e5630c5a03600cc0cbb958cec54c2116e3794d4d39b0d37717d8226207183a7
6
+ metadata.gz: 063a4e86f5c39639528877e9b0d2e041d0324e004465e3ad7b7232fe2ae663105c758f91a000f15c911399daf3ab5c60cf13a57458abcb880b12d56d7d0b99b7
7
+ data.tar.gz: 76cfedf73cff40f2383f9448e1db57bbed078c8b9fab7fbf526fd1f82885bab44c322a122e5918ac72d32f1269b98ce526bbefc58357161cc71cad9706cbdb96
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- 2.5.1
1
+ 2.5.9
data/Gemfile CHANGED
@@ -13,7 +13,7 @@
13
13
  # language governing permissions and limitations under the License.
14
14
 
15
15
  source 'https://rubygems.org'
16
- ruby '2.5.1'
16
+ ruby '2.5.9'
17
17
 
18
18
  gem "rake", "12.3.3"
19
19
  gem "minitest", "5.8.3"
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fusionauth_client (1.32.1)
4
+ fusionauth_client (1.36.0)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
@@ -21,7 +21,7 @@ DEPENDENCIES
21
21
  rake (= 12.3.3)
22
22
 
23
23
  RUBY VERSION
24
- ruby 2.5.1p57
24
+ ruby 2.5.9p229
25
25
 
26
26
  BUNDLED WITH
27
27
  2.2.5
data/README.md CHANGED
@@ -63,7 +63,7 @@ user = response.success.response.user
63
63
 
64
64
  If you have a question or support issue regarding this client library, we'd love to hear from you.
65
65
 
66
- If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing/).
66
+ If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing).
67
67
 
68
68
  Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
69
69
 
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.32.1", licenses: ["ApacheV2_0"]) {
19
+ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.36.0", licenses: ["ApacheV2_0"]) {
20
20
  workflow {
21
21
  fetch {
22
22
  cache()
@@ -40,7 +40,7 @@ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.32.1
40
40
  }
41
41
 
42
42
  // Plugins
43
- file = loadPlugin(id: "org.savantbuild.plugin:file:${savantVersion}")
43
+ file = loadPlugin(id: "org.savantbuild.plugin:file:1.0.2")
44
44
  release = loadPlugin(id: "org.savantbuild.plugin:release-git:${savantVersion}")
45
45
 
46
46
  target(name: "clean", description: "Cleans build directory") {
@@ -6,11 +6,11 @@
6
6
  <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
7
7
  <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
8
8
  </content>
9
- <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
9
+ <orderEntry type="jdk" jdkName="rbenv: 2.5.9" jdkType="RUBY_SDK" />
10
10
  <orderEntry type="sourceFolder" forTests="false" />
11
- <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.1) [gem]" level="application" />
12
- <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
13
- <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
11
+ <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.9) [gem]" level="application" />
12
+ <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.9) [gem]" level="application" />
13
+ <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.9) [gem]" level="application" />
14
14
  </component>
15
15
  <component name="RakeTasksCache">
16
16
  <option name="myRootTask">
@@ -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.32.1'
7
+ spec.version = '1.36.0'
8
8
  spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
9
9
  spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
10
10
 
@@ -98,6 +98,9 @@ module FusionAuth
98
98
  #
99
99
  # Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user
100
100
  # and they clicked on a link to reset their password.
101
+ #
102
+ # As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set
103
+ # the value in the request body.
101
104
  #
102
105
  # @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.
103
106
  # @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
@@ -124,6 +127,54 @@ module FusionAuth
124
127
  .go()
125
128
  end
126
129
 
130
+ #
131
+ # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
132
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
133
+ # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
134
+ #
135
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
136
+ #
137
+ # @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.
138
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
139
+ def check_change_password_using_id(change_password_id)
140
+ startAnonymous.uri('/api/user/change-password')
141
+ .url_segment(change_password_id)
142
+ .get()
143
+ .go()
144
+ end
145
+
146
+ #
147
+ # Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
148
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
149
+ # your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
150
+ #
151
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
152
+ #
153
+ # @param encoded_jwt [string] The encoded JWT (access token).
154
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
155
+ def check_change_password_using_jwt(encoded_jwt)
156
+ startAnonymous.uri('/api/user/change-password')
157
+ .authorization('Bearer ' + encoded_jwt)
158
+ .get()
159
+ .go()
160
+ end
161
+
162
+ #
163
+ # Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
164
+ # When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
165
+ # your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.
166
+ #
167
+ # An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
168
+ #
169
+ # @param login_id [string] The loginId of the User that you intend to change the password for.
170
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
171
+ def check_change_password_using_login_id(login_id)
172
+ start.uri('/api/user/change-password')
173
+ .url_parameter('username', login_id)
174
+ .get()
175
+ .go()
176
+ end
177
+
127
178
  #
128
179
  # Adds a comment to the user's account.
129
180
  #
@@ -2025,7 +2076,7 @@ module FusionAuth
2025
2076
  end
2026
2077
 
2027
2078
  #
2028
- # Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
2079
+ # Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
2029
2080
  # and inactive as well as non-time based actions.
2030
2081
  #
2031
2082
  # @param user_id [string] The Id of the user to fetch the actions for.
@@ -2038,7 +2089,7 @@ module FusionAuth
2038
2089
  end
2039
2090
 
2040
2091
  #
2041
- # Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
2092
+ # Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
2042
2093
  #
2043
2094
  # @param user_id [string] The Id of the user to fetch the actions for.
2044
2095
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2051,7 +2102,7 @@ module FusionAuth
2051
2102
  end
2052
2103
 
2053
2104
  #
2054
- # Retrieves all of the actions for the user with the given Id that are currently active.
2105
+ # Retrieves all the actions for the user with the given Id that are currently active.
2055
2106
  # An active action means one that is time based and has not been canceled, and has not ended.
2056
2107
  #
2057
2108
  # @param user_id [string] The Id of the user to fetch the actions for.
@@ -2077,7 +2128,7 @@ module FusionAuth
2077
2128
  end
2078
2129
 
2079
2130
  #
2080
- # Retrieves all of the applications.
2131
+ # Retrieves all the applications.
2081
2132
  #
2082
2133
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2083
2134
  def retrieve_applications()
@@ -2111,7 +2162,7 @@ module FusionAuth
2111
2162
  end
2112
2163
 
2113
2164
  #
2114
- # Retrieves all of the connectors.
2165
+ # Retrieves all the connectors.
2115
2166
  #
2116
2167
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2117
2168
  def retrieve_connectors()
@@ -2133,7 +2184,7 @@ module FusionAuth
2133
2184
  end
2134
2185
 
2135
2186
  #
2136
- # Retrieves all of the consent.
2187
+ # Retrieves all the consent.
2137
2188
  #
2138
2189
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2139
2190
  def retrieve_consents()
@@ -2186,7 +2237,7 @@ module FusionAuth
2186
2237
  end
2187
2238
 
2188
2239
  #
2189
- # Retrieves all of the email templates.
2240
+ # Retrieves all the email templates.
2190
2241
  #
2191
2242
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2192
2243
  def retrieve_email_templates()
@@ -2237,7 +2288,7 @@ module FusionAuth
2237
2288
  end
2238
2289
 
2239
2290
  #
2240
- # Retrieves all of the Entity Types.
2291
+ # Retrieves all the Entity Types.
2241
2292
  #
2242
2293
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2243
2294
  def retrieve_entity_types()
@@ -2259,7 +2310,7 @@ module FusionAuth
2259
2310
  end
2260
2311
 
2261
2312
  #
2262
- # Retrieves all of the families that a user belongs to.
2313
+ # Retrieves all the families that a user belongs to.
2263
2314
  #
2264
2315
  # @param user_id [string] The User's id
2265
2316
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2271,7 +2322,7 @@ module FusionAuth
2271
2322
  end
2272
2323
 
2273
2324
  #
2274
- # Retrieves all of the members of a family by the unique Family Id.
2325
+ # Retrieves all the members of a family by the unique Family Id.
2275
2326
  #
2276
2327
  # @param family_id [string] The unique Id of the Family.
2277
2328
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2307,7 +2358,7 @@ module FusionAuth
2307
2358
  end
2308
2359
 
2309
2360
  #
2310
- # Retrieves all of the forms fields
2361
+ # Retrieves all the forms fields
2311
2362
  #
2312
2363
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2313
2364
  def retrieve_form_fields()
@@ -2317,7 +2368,7 @@ module FusionAuth
2317
2368
  end
2318
2369
 
2319
2370
  #
2320
- # Retrieves all of the forms.
2371
+ # Retrieves all the forms.
2321
2372
  #
2322
2373
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2323
2374
  def retrieve_forms()
@@ -2339,7 +2390,7 @@ module FusionAuth
2339
2390
  end
2340
2391
 
2341
2392
  #
2342
- # Retrieves all of the groups.
2393
+ # Retrieves all the groups.
2343
2394
  #
2344
2395
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2345
2396
  def retrieve_groups()
@@ -2387,7 +2438,7 @@ module FusionAuth
2387
2438
  end
2388
2439
 
2389
2440
  #
2390
- # Retrieves all of the identity providers.
2441
+ # Retrieves all the identity providers.
2391
2442
  #
2392
2443
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2393
2444
  def retrieve_identity_providers()
@@ -2397,7 +2448,7 @@ module FusionAuth
2397
2448
  end
2398
2449
 
2399
2450
  #
2400
- # Retrieves all of the actions for the user with the given Id that are currently inactive.
2451
+ # Retrieves all the actions for the user with the given Id that are currently inactive.
2401
2452
  # An inactive action means one that is time based and has been canceled or has expired, or is not time based.
2402
2453
  #
2403
2454
  # @param user_id [string] The Id of the user to fetch the actions for.
@@ -2411,7 +2462,7 @@ module FusionAuth
2411
2462
  end
2412
2463
 
2413
2464
  #
2414
- # Retrieves all of the applications that are currently inactive.
2465
+ # Retrieves all the applications that are currently inactive.
2415
2466
  #
2416
2467
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2417
2468
  def retrieve_inactive_applications()
@@ -2422,7 +2473,7 @@ module FusionAuth
2422
2473
  end
2423
2474
 
2424
2475
  #
2425
- # Retrieves all of the user actions that are currently inactive.
2476
+ # Retrieves all the user actions that are currently inactive.
2426
2477
  #
2427
2478
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2428
2479
  def retrieve_inactive_user_actions()
@@ -2499,7 +2550,7 @@ module FusionAuth
2499
2550
  end
2500
2551
 
2501
2552
  #
2502
- # Retrieves all of the keys.
2553
+ # Retrieves all the keys.
2503
2554
  #
2504
2555
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2505
2556
  def retrieve_keys()
@@ -2521,7 +2572,7 @@ module FusionAuth
2521
2572
  end
2522
2573
 
2523
2574
  #
2524
- # Retrieves all of the lambdas.
2575
+ # Retrieves all the lambdas.
2525
2576
  #
2526
2577
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2527
2578
  def retrieve_lambdas()
@@ -2531,7 +2582,7 @@ module FusionAuth
2531
2582
  end
2532
2583
 
2533
2584
  #
2534
- # Retrieves all of the lambdas for the provided type.
2585
+ # Retrieves all the lambdas for the provided type.
2535
2586
  #
2536
2587
  # @param type [OpenStruct, Hash] The type of the lambda to return.
2537
2588
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2584,7 +2635,7 @@ module FusionAuth
2584
2635
  end
2585
2636
 
2586
2637
  #
2587
- # Retrieves all of the message templates.
2638
+ # Retrieves all the message templates.
2588
2639
  #
2589
2640
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2590
2641
  def retrieve_message_templates()
@@ -2606,7 +2657,7 @@ module FusionAuth
2606
2657
  end
2607
2658
 
2608
2659
  #
2609
- # Retrieves all of the messengers.
2660
+ # Retrieves all the messengers.
2610
2661
  #
2611
2662
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2612
2663
  def retrieve_messengers()
@@ -2683,7 +2734,7 @@ module FusionAuth
2683
2734
  end
2684
2735
 
2685
2736
  #
2686
- # Retrieves all of the children for the given parent email address.
2737
+ # Retrieves all the children for the given parent email address.
2687
2738
  #
2688
2739
  # @param parent_email [string] The email of the parent.
2689
2740
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2817,7 +2868,7 @@ module FusionAuth
2817
2868
  end
2818
2869
 
2819
2870
  #
2820
- # Retrieves all of the tenants.
2871
+ # Retrieves all the tenants.
2821
2872
  #
2822
2873
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2823
2874
  def retrieve_tenants()
@@ -2839,7 +2890,7 @@ module FusionAuth
2839
2890
  end
2840
2891
 
2841
2892
  #
2842
- # Retrieves all of the themes.
2893
+ # Retrieves all the themes.
2843
2894
  #
2844
2895
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2845
2896
  def retrieve_themes()
@@ -2920,7 +2971,7 @@ module FusionAuth
2920
2971
  end
2921
2972
 
2922
2973
  #
2923
- # Retrieves all of the user actions.
2974
+ # Retrieves all the user actions.
2924
2975
  #
2925
2976
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
2926
2977
  def retrieve_user_actions()
@@ -2992,7 +3043,7 @@ module FusionAuth
2992
3043
  end
2993
3044
 
2994
3045
  #
2995
- # Retrieves all of the comments for the user with the given Id.
3046
+ # Retrieves all the comments for the user with the given Id.
2996
3047
  #
2997
3048
  # @param user_id [string] The Id of the user.
2998
3049
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3016,7 +3067,7 @@ module FusionAuth
3016
3067
  end
3017
3068
 
3018
3069
  #
3019
- # Retrieves all of the consents for a User.
3070
+ # Retrieves all the consents for a User.
3020
3071
  #
3021
3072
  # @param user_id [string] The User's Id
3022
3073
  # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3365,6 +3416,18 @@ module FusionAuth
3365
3416
  .go()
3366
3417
  end
3367
3418
 
3419
+ #
3420
+ # Searches group members with the specified criteria and pagination.
3421
+ #
3422
+ # @param request [OpenStruct, Hash] The search criteria and pagination information.
3423
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
3424
+ def search_group_members(request)
3425
+ start.uri('/api/group/member/search')
3426
+ .body_handler(FusionAuth::JSONBodyHandler.new(request))
3427
+ .post()
3428
+ .go()
3429
+ end
3430
+
3368
3431
  #
3369
3432
  # Searches the IP Access Control Lists with the specified criteria and pagination.
3370
3433
  #
@@ -3761,6 +3824,18 @@ module FusionAuth
3761
3824
  .go()
3762
3825
  end
3763
3826
 
3827
+ #
3828
+ # Creates a member in a group.
3829
+ #
3830
+ # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group member(s).
3831
+ # @return [FusionAuth::ClientResponse] The ClientResponse object.
3832
+ def update_group_members(request)
3833
+ start.uri('/api/group/member')
3834
+ .body_handler(FusionAuth::JSONBodyHandler.new(request))
3835
+ .put()
3836
+ .go()
3837
+ end
3838
+
3764
3839
  #
3765
3840
  # Updates the IP Access Control List with the given Id.
3766
3841
  #
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fusionauth_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.32.1
4
+ version: 1.36.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brian Pontarelli
8
8
  - Daniel DeGroff
9
- autorequire:
9
+ autorequire:
10
10
  bindir: exe
11
11
  cert_chain: []
12
- date: 2021-12-13 00:00:00.000000000 Z
12
+ date: 2022-04-08 00:00:00.000000000 Z
13
13
  dependencies: []
14
14
  description: This library contains the Ruby client library that helps you connect
15
15
  your application to FusionAuth.
@@ -37,7 +37,7 @@ licenses:
37
37
  - Apache-2.0
38
38
  metadata:
39
39
  allowed_push_host: https://rubygems.org
40
- post_install_message:
40
+ post_install_message:
41
41
  rdoc_options: []
42
42
  require_paths:
43
43
  - lib
@@ -52,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
52
52
  - !ruby/object:Gem::Version
53
53
  version: '0'
54
54
  requirements: []
55
- rubygems_version: 3.1.4
56
- signing_key:
55
+ rubygems_version: 3.3.5
56
+ signing_key:
57
57
  specification_version: 4
58
58
  summary: The Ruby client library for FusionAuth
59
59
  test_files: []