fusionauth_client 1.68.0 → 1.70.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/fusionauth/docker-compose.yml +1 -1
- data/.github/fusionauth/kickstart.json +1 -2
- data/.github/fusionauth/poll-for-kickstart-finish.sh +38 -0
- data/.ruby-version +1 -1
- data/Gemfile +1 -1
- data/Gemfile.lock +2 -2
- data/build.savant +1 -1
- data/fusionauth_client.gemspec +1 -1
- data/lib/fusionauth/fusionauth_client.rb +352 -41
- metadata +4 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 37dc8a299b85dcdec0f6c1395d88abb69c20da243fdcca8b169e367f8f864480
|
|
4
|
+
data.tar.gz: a222216587c741f084ca332866636015fe87f8665c34d23bc818671249ac3e2e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c2a5cba468e28e0bee06d1f620f2dd1a1e95dcbd37501c381bd4d5ea26b3db85ed8b4bbf56736ebebca8b7d791c03d3b9b7f558822a1d870836b94fc202791b1
|
|
7
|
+
data.tar.gz: 454593bb0358b02dbb4c09e32a2f0fda1642b6b659073d792dd6d168fbeec9ed921e6ff17e55c769c81ab9c935487bc553845ebfd94d2620bf7f2c96336c6f40
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"variables": {
|
|
3
3
|
"applicationId": "3c219e58-ed0e-4b18-ad48-f4f92793ae32",
|
|
4
|
-
"apiKey": "72a8c464b86c3c9098c33da73f471b8a0352f6e14087ddc3",
|
|
5
4
|
"asymmetricKeyId": "#{UUID()}",
|
|
6
5
|
"defaultTenantId": "d7d09513-a3f5-401c-9685-34ab6c552453",
|
|
7
6
|
"adminEmail": "admin@example.com",
|
|
@@ -9,7 +8,7 @@
|
|
|
9
8
|
},
|
|
10
9
|
"apiKeys": [
|
|
11
10
|
{
|
|
12
|
-
"key": "
|
|
11
|
+
"key": "bf69486b-4733-4470-a592-f1bfce7af580",
|
|
13
12
|
"description": "Unrestricted API key"
|
|
14
13
|
}
|
|
15
14
|
],
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Copyright (c) 2026, FusionAuth, All Rights Reserved
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing,
|
|
11
|
+
# software distributed under the License is distributed on an
|
|
12
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
13
|
+
# either express or implied. See the License for the specific
|
|
14
|
+
# language governing permissions and limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
|
|
17
|
+
cd $(dirname "$0")
|
|
18
|
+
|
|
19
|
+
isFusionAuthReady () {
|
|
20
|
+
docker compose logs fusionauth 2>&1 | grep -Fq 'Completed [POST] request to [/api/user/registration]'
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
max_retries=20
|
|
24
|
+
i=1
|
|
25
|
+
while [ "$i" -le "$max_retries" ]; do
|
|
26
|
+
echo -n "[$i/$max_retries] Waiting for FusionAuth server to start... "
|
|
27
|
+
|
|
28
|
+
if isFusionAuthReady; then
|
|
29
|
+
echo "READY"
|
|
30
|
+
exit 0
|
|
31
|
+
fi
|
|
32
|
+
|
|
33
|
+
echo "NOT READY"
|
|
34
|
+
sleep 5
|
|
35
|
+
i=$((i + 1))
|
|
36
|
+
done
|
|
37
|
+
|
|
38
|
+
exit 1
|
data/.ruby-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.4.
|
|
1
|
+
3.4.12
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
fusionauth_client (1.
|
|
4
|
+
fusionauth_client (1.70.0)
|
|
5
5
|
|
|
6
6
|
GEM
|
|
7
7
|
remote: https://rubygems.org/
|
|
@@ -63,7 +63,7 @@ DEPENDENCIES
|
|
|
63
63
|
rdoc-markdown (~> 0.4.2)
|
|
64
64
|
|
|
65
65
|
RUBY VERSION
|
|
66
|
-
ruby 3.4.
|
|
66
|
+
ruby 3.4.12p148
|
|
67
67
|
|
|
68
68
|
BUNDLED WITH
|
|
69
69
|
2.6.2
|
data/build.savant
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
pubVersion = ""
|
|
18
|
-
project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.
|
|
18
|
+
project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.70.0", licenses: ["ApacheV2_0"]) {
|
|
19
19
|
workflow {
|
|
20
20
|
fetch {
|
|
21
21
|
cache()
|
data/fusionauth_client.gemspec
CHANGED
|
@@ -19,7 +19,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
|
19
19
|
|
|
20
20
|
Gem::Specification.new do |spec|
|
|
21
21
|
spec.name = 'fusionauth_client'
|
|
22
|
-
spec.version = '1.
|
|
22
|
+
spec.version = '1.70.0'
|
|
23
23
|
spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
|
|
24
24
|
spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
|
|
25
25
|
|
|
@@ -507,6 +507,38 @@ module FusionAuth
|
|
|
507
507
|
.go
|
|
508
508
|
end
|
|
509
509
|
|
|
510
|
+
#
|
|
511
|
+
# Creates a CIMD domain. You can optionally provide an Id for the CIMD domain, if not provided one will be generated.
|
|
512
|
+
#
|
|
513
|
+
# @param domain_id [string] (Optional) The Id to use for the CIMD domain. If not provided a secure random UUID will be generated.
|
|
514
|
+
# @param request [OpenStruct, Hash] The request object that contains all the information used to create the CIMD domain.
|
|
515
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
516
|
+
def create_cimd_domain(domain_id, request)
|
|
517
|
+
start.uri('/api/cimd/domain')
|
|
518
|
+
.url_segment(domain_id)
|
|
519
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
520
|
+
.post
|
|
521
|
+
.go
|
|
522
|
+
end
|
|
523
|
+
|
|
524
|
+
#
|
|
525
|
+
# Creates a new custom OAuth scope for a CIMD Domain. You must specify the Id of the CIMD domain you are creating the scope for.
|
|
526
|
+
# You can optionally specify an Id for the OAuth scope on the URL, if not provided one will be generated.
|
|
527
|
+
#
|
|
528
|
+
# @param domain_id [string] The Id of the CIMD domain to create the OAuth scope on.
|
|
529
|
+
# @param scope_id [string] (Optional) The Id of the OAuth scope. If not provided a secure random UUID will be generated.
|
|
530
|
+
# @param request [OpenStruct, Hash] The request object that contains all the information used to create the OAuth scope.
|
|
531
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
532
|
+
def create_cimd_domain_o_auth_scope(domain_id, scope_id, request)
|
|
533
|
+
start.uri('/api/cimd/domain')
|
|
534
|
+
.url_segment(domain_id)
|
|
535
|
+
.url_segment("scope")
|
|
536
|
+
.url_segment(scope_id)
|
|
537
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
538
|
+
.post
|
|
539
|
+
.go
|
|
540
|
+
end
|
|
541
|
+
|
|
510
542
|
#
|
|
511
543
|
# Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
|
|
512
544
|
#
|
|
@@ -740,7 +772,7 @@ module FusionAuth
|
|
|
740
772
|
#
|
|
741
773
|
# @param application_id [string] The Id of the application to create the OAuth scope on.
|
|
742
774
|
# @param scope_id [string] (Optional) The Id of the OAuth scope. If not provided a secure random UUID will be generated.
|
|
743
|
-
# @param request [OpenStruct, Hash] The request object that contains all the information used to create the OAuth
|
|
775
|
+
# @param request [OpenStruct, Hash] The request object that contains all the information used to create the OAuth scope.
|
|
744
776
|
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
745
777
|
def create_o_auth_scope(application_id, scope_id, request)
|
|
746
778
|
start.uri('/api/application')
|
|
@@ -997,6 +1029,46 @@ module FusionAuth
|
|
|
997
1029
|
.go
|
|
998
1030
|
end
|
|
999
1031
|
|
|
1032
|
+
#
|
|
1033
|
+
# Deletes the CIMD client registration for the given Id, along with its refresh tokens.
|
|
1034
|
+
#
|
|
1035
|
+
# @param registration_id [string] The Id of the CIMD client registration to delete.
|
|
1036
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
1037
|
+
def delete_cimd_client_registration(registration_id)
|
|
1038
|
+
start.uri('/api/cimd/registration')
|
|
1039
|
+
.url_segment(registration_id)
|
|
1040
|
+
.delete
|
|
1041
|
+
.go
|
|
1042
|
+
end
|
|
1043
|
+
|
|
1044
|
+
#
|
|
1045
|
+
# Deletes the CIMD domain for the given Id.
|
|
1046
|
+
#
|
|
1047
|
+
# @param domain_id [string] The Id of the CIMD domain to delete.
|
|
1048
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
1049
|
+
def delete_cimd_domain(domain_id)
|
|
1050
|
+
start.uri('/api/cimd/domain')
|
|
1051
|
+
.url_segment(domain_id)
|
|
1052
|
+
.delete
|
|
1053
|
+
.go
|
|
1054
|
+
end
|
|
1055
|
+
|
|
1056
|
+
#
|
|
1057
|
+
# Hard deletes a custom OAuth scope for a CIMD Domain.
|
|
1058
|
+
# OAuth workflows that are still requesting the deleted OAuth scope may fail depending on the CIMD domain's unknown scope policy.
|
|
1059
|
+
#
|
|
1060
|
+
# @param domain_id [string] The Id of the CIMD domain that the OAuth scope belongs to.
|
|
1061
|
+
# @param scope_id [string] The Id of the OAuth scope to delete.
|
|
1062
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
1063
|
+
def delete_cimd_domain_o_auth_scope(domain_id, scope_id)
|
|
1064
|
+
start.uri('/api/cimd/domain')
|
|
1065
|
+
.url_segment(domain_id)
|
|
1066
|
+
.url_segment("scope")
|
|
1067
|
+
.url_segment(scope_id)
|
|
1068
|
+
.delete
|
|
1069
|
+
.go
|
|
1070
|
+
end
|
|
1071
|
+
|
|
1000
1072
|
#
|
|
1001
1073
|
# Deletes the connector for the given Id.
|
|
1002
1074
|
#
|
|
@@ -2188,6 +2260,37 @@ module FusionAuth
|
|
|
2188
2260
|
.go
|
|
2189
2261
|
end
|
|
2190
2262
|
|
|
2263
|
+
#
|
|
2264
|
+
# Updates, via PATCH, the CIMD domain with the given Id.
|
|
2265
|
+
#
|
|
2266
|
+
# @param domain_id [string] The Id of the CIMD domain to update.
|
|
2267
|
+
# @param request [OpenStruct, Hash] The request that contains just the new CIMD domain information.
|
|
2268
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2269
|
+
def patch_cimd_domain(domain_id, request)
|
|
2270
|
+
start.uri('/api/cimd/domain')
|
|
2271
|
+
.url_segment(domain_id)
|
|
2272
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
2273
|
+
.patch
|
|
2274
|
+
.go
|
|
2275
|
+
end
|
|
2276
|
+
|
|
2277
|
+
#
|
|
2278
|
+
# Updates, via PATCH, the custom OAuth scope with the given Id for the CIMD domain.
|
|
2279
|
+
#
|
|
2280
|
+
# @param domain_id [string] The Id of the CIMD domain that the OAuth scope belongs to.
|
|
2281
|
+
# @param scope_id [string] The Id of the OAuth scope to update.
|
|
2282
|
+
# @param request [OpenStruct, Hash] The request that contains just the new OAuth scope information.
|
|
2283
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2284
|
+
def patch_cimd_domain_o_auth_scope(domain_id, scope_id, request)
|
|
2285
|
+
start.uri('/api/cimd/domain')
|
|
2286
|
+
.url_segment(domain_id)
|
|
2287
|
+
.url_segment("scope")
|
|
2288
|
+
.url_segment(scope_id)
|
|
2289
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
2290
|
+
.patch
|
|
2291
|
+
.go
|
|
2292
|
+
end
|
|
2293
|
+
|
|
2191
2294
|
#
|
|
2192
2295
|
# Updates, via PATCH, the connector with the given Id.
|
|
2193
2296
|
#
|
|
@@ -2840,6 +2943,55 @@ module FusionAuth
|
|
|
2840
2943
|
.go
|
|
2841
2944
|
end
|
|
2842
2945
|
|
|
2946
|
+
#
|
|
2947
|
+
# Retrieves the CIMD client registration for the given Id.
|
|
2948
|
+
#
|
|
2949
|
+
# @param registration_id [string] The Id of the CIMD client registration.
|
|
2950
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2951
|
+
def retrieve_cimd_client_registration(registration_id)
|
|
2952
|
+
start.uri('/api/cimd/registration')
|
|
2953
|
+
.url_segment(registration_id)
|
|
2954
|
+
.get
|
|
2955
|
+
.go
|
|
2956
|
+
end
|
|
2957
|
+
|
|
2958
|
+
#
|
|
2959
|
+
# Retrieves the CIMD domain for the given Id.
|
|
2960
|
+
#
|
|
2961
|
+
# @param domain_id [string] The Id of the CIMD domain.
|
|
2962
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2963
|
+
def retrieve_cimd_domain(domain_id)
|
|
2964
|
+
start.uri('/api/cimd/domain')
|
|
2965
|
+
.url_segment(domain_id)
|
|
2966
|
+
.get
|
|
2967
|
+
.go
|
|
2968
|
+
end
|
|
2969
|
+
|
|
2970
|
+
#
|
|
2971
|
+
# Retrieves a custom OAuth scope for a CIMD Domain.
|
|
2972
|
+
#
|
|
2973
|
+
# @param domain_id [string] The Id of the CIMD domain that the OAuth scope belongs to.
|
|
2974
|
+
# @param scope_id [string] The Id of the OAuth scope to retrieve.
|
|
2975
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2976
|
+
def retrieve_cimd_domain_o_auth_scope(domain_id, scope_id)
|
|
2977
|
+
start.uri('/api/cimd/domain')
|
|
2978
|
+
.url_segment(domain_id)
|
|
2979
|
+
.url_segment("scope")
|
|
2980
|
+
.url_segment(scope_id)
|
|
2981
|
+
.get
|
|
2982
|
+
.go
|
|
2983
|
+
end
|
|
2984
|
+
|
|
2985
|
+
#
|
|
2986
|
+
# Retrieves all the CIMD domains for the tenant in context.
|
|
2987
|
+
#
|
|
2988
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
2989
|
+
def retrieve_cimd_domains
|
|
2990
|
+
start.uri('/api/cimd/domain')
|
|
2991
|
+
.get
|
|
2992
|
+
.go
|
|
2993
|
+
end
|
|
2994
|
+
|
|
2843
2995
|
#
|
|
2844
2996
|
# Retrieves the connector with the given Id.
|
|
2845
2997
|
#
|
|
@@ -3875,46 +4027,6 @@ module FusionAuth
|
|
|
3875
4027
|
.go
|
|
3876
4028
|
end
|
|
3877
4029
|
|
|
3878
|
-
#
|
|
3879
|
-
# Retrieve a user_code that is part of an in-progress Device Authorization Grant.
|
|
3880
|
-
#
|
|
3881
|
-
# This API is useful if you want to build your own login workflow to complete a device grant.
|
|
3882
|
-
#
|
|
3883
|
-
# @param client_id [string] The client Id.
|
|
3884
|
-
# @param client_secret [string] The client Id.
|
|
3885
|
-
# @param user_code [string] The end-user verification code.
|
|
3886
|
-
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
3887
|
-
def retrieve_user_code(client_id, client_secret, user_code)
|
|
3888
|
-
form_parameters = {
|
|
3889
|
-
"client_id" => client_id,
|
|
3890
|
-
"client_secret" => client_secret,
|
|
3891
|
-
"user_code" => user_code,
|
|
3892
|
-
}
|
|
3893
|
-
startAnonymous.uri('/oauth2/device/user-code')
|
|
3894
|
-
.body_handler(FusionAuth::FormDataBodyHandler.new(form_parameters))
|
|
3895
|
-
.get
|
|
3896
|
-
.go
|
|
3897
|
-
end
|
|
3898
|
-
|
|
3899
|
-
#
|
|
3900
|
-
# Retrieve a user_code that is part of an in-progress Device Authorization Grant.
|
|
3901
|
-
#
|
|
3902
|
-
# This API is useful if you want to build your own login workflow to complete a device grant.
|
|
3903
|
-
#
|
|
3904
|
-
# This request will require an API key.
|
|
3905
|
-
#
|
|
3906
|
-
# @param user_code [string] The end-user verification code.
|
|
3907
|
-
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
3908
|
-
def retrieve_user_code_using_api_key(user_code)
|
|
3909
|
-
form_parameters = {
|
|
3910
|
-
"user_code" => user_code,
|
|
3911
|
-
}
|
|
3912
|
-
startAnonymous.uri('/oauth2/device/user-code')
|
|
3913
|
-
.body_handler(FusionAuth::FormDataBodyHandler.new(form_parameters))
|
|
3914
|
-
.get
|
|
3915
|
-
.go
|
|
3916
|
-
end
|
|
3917
|
-
|
|
3918
4030
|
#
|
|
3919
4031
|
# Retrieve a user_code that is part of an in-progress Device Authorization Grant.
|
|
3920
4032
|
#
|
|
@@ -4338,6 +4450,30 @@ module FusionAuth
|
|
|
4338
4450
|
.go
|
|
4339
4451
|
end
|
|
4340
4452
|
|
|
4453
|
+
#
|
|
4454
|
+
# Searches the CIMD client registrations with the specified criteria and pagination.
|
|
4455
|
+
#
|
|
4456
|
+
# @param request [OpenStruct, Hash] The search criteria and pagination information.
|
|
4457
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4458
|
+
def search_cimd_client_registrations(request)
|
|
4459
|
+
start.uri('/api/cimd/registration/search')
|
|
4460
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
4461
|
+
.post
|
|
4462
|
+
.go
|
|
4463
|
+
end
|
|
4464
|
+
|
|
4465
|
+
#
|
|
4466
|
+
# Searches the CIMD domains with the specified criteria and pagination.
|
|
4467
|
+
#
|
|
4468
|
+
# @param request [OpenStruct, Hash] The search criteria and pagination information.
|
|
4469
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4470
|
+
def search_cimd_domains(request)
|
|
4471
|
+
start.uri('/api/cimd/domain/search')
|
|
4472
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
4473
|
+
.post
|
|
4474
|
+
.go
|
|
4475
|
+
end
|
|
4476
|
+
|
|
4341
4477
|
#
|
|
4342
4478
|
# Searches consents with the specified criteria and pagination.
|
|
4343
4479
|
#
|
|
@@ -4350,6 +4486,24 @@ module FusionAuth
|
|
|
4350
4486
|
.go
|
|
4351
4487
|
end
|
|
4352
4488
|
|
|
4489
|
+
#
|
|
4490
|
+
# Searches consents with the specified criteria and pagination.
|
|
4491
|
+
#
|
|
4492
|
+
# @param name [string] (Optional) The name of the consent to search for. Supports wildcard search using *.
|
|
4493
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4494
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: id, insertInstant, name.
|
|
4495
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4496
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4497
|
+
def search_consents_by_parameters(name, number_of_results, order_by, start_row)
|
|
4498
|
+
start.uri('/api/consent/search')
|
|
4499
|
+
.url_parameter('name', name)
|
|
4500
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4501
|
+
.url_parameter('orderBy', order_by)
|
|
4502
|
+
.url_parameter('startRow', start_row)
|
|
4503
|
+
.get
|
|
4504
|
+
.go
|
|
4505
|
+
end
|
|
4506
|
+
|
|
4353
4507
|
#
|
|
4354
4508
|
# Searches email templates with the specified criteria and pagination.
|
|
4355
4509
|
#
|
|
@@ -4398,6 +4552,28 @@ module FusionAuth
|
|
|
4398
4552
|
.go
|
|
4399
4553
|
end
|
|
4400
4554
|
|
|
4555
|
+
#
|
|
4556
|
+
# Searches entity grants with the specified criteria and pagination.
|
|
4557
|
+
#
|
|
4558
|
+
# @param entity_id [string] (Optional) The entity Id to search for grants on.
|
|
4559
|
+
# @param name [string] (Optional) The name of the entity grant to search for. Supports wildcard search using *.
|
|
4560
|
+
# @param user_id [string] (Optional) The user Id to search for grants on.
|
|
4561
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4562
|
+
# @param order_by [string] (Optional) The field to order the results by.
|
|
4563
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4564
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4565
|
+
def search_entity_grants_by_parameters(entity_id, name, user_id, number_of_results, order_by, start_row)
|
|
4566
|
+
start.uri('/api/entity/grant/search')
|
|
4567
|
+
.url_parameter('entityId', entity_id)
|
|
4568
|
+
.url_parameter('name', name)
|
|
4569
|
+
.url_parameter('userId', user_id)
|
|
4570
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4571
|
+
.url_parameter('orderBy', order_by)
|
|
4572
|
+
.url_parameter('startRow', start_row)
|
|
4573
|
+
.get
|
|
4574
|
+
.go
|
|
4575
|
+
end
|
|
4576
|
+
|
|
4401
4577
|
#
|
|
4402
4578
|
# Searches the entity types with the specified criteria and pagination.
|
|
4403
4579
|
#
|
|
@@ -4410,6 +4586,24 @@ module FusionAuth
|
|
|
4410
4586
|
.go
|
|
4411
4587
|
end
|
|
4412
4588
|
|
|
4589
|
+
#
|
|
4590
|
+
# Searches entity types with the specified criteria and pagination.
|
|
4591
|
+
#
|
|
4592
|
+
# @param name [string] The name of the entity type to search for. Use * to return all entity types.
|
|
4593
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4594
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: insertInstant, lastUpdateInstant, name.
|
|
4595
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4596
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4597
|
+
def search_entity_types_by_parameters(name, number_of_results, order_by, start_row)
|
|
4598
|
+
start.uri('/api/entity/type/search')
|
|
4599
|
+
.url_parameter('name', name)
|
|
4600
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4601
|
+
.url_parameter('orderBy', order_by)
|
|
4602
|
+
.url_parameter('startRow', start_row)
|
|
4603
|
+
.get
|
|
4604
|
+
.go
|
|
4605
|
+
end
|
|
4606
|
+
|
|
4413
4607
|
#
|
|
4414
4608
|
# Searches the event logs with the specified criteria and pagination.
|
|
4415
4609
|
#
|
|
@@ -4458,6 +4652,24 @@ module FusionAuth
|
|
|
4458
4652
|
.go
|
|
4459
4653
|
end
|
|
4460
4654
|
|
|
4655
|
+
#
|
|
4656
|
+
# Searches IP access control lists with the specified criteria and pagination.
|
|
4657
|
+
#
|
|
4658
|
+
# @param name [string] (Optional) The name of the IP access control list to search for. Supports wildcard search using *.
|
|
4659
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4660
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: id, insertInstant, lastUpdateInstant, name.
|
|
4661
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4662
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4663
|
+
def search_ip_access_control_lists_by_parameters(name, number_of_results, order_by, start_row)
|
|
4664
|
+
start.uri('/api/ip-acl/search')
|
|
4665
|
+
.url_parameter('name', name)
|
|
4666
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4667
|
+
.url_parameter('orderBy', order_by)
|
|
4668
|
+
.url_parameter('startRow', start_row)
|
|
4669
|
+
.get
|
|
4670
|
+
.go
|
|
4671
|
+
end
|
|
4672
|
+
|
|
4461
4673
|
#
|
|
4462
4674
|
# Searches identity providers with the specified criteria and pagination.
|
|
4463
4675
|
#
|
|
@@ -4470,6 +4682,30 @@ module FusionAuth
|
|
|
4470
4682
|
.go
|
|
4471
4683
|
end
|
|
4472
4684
|
|
|
4685
|
+
#
|
|
4686
|
+
# Searches identity providers with the specified criteria and pagination.
|
|
4687
|
+
#
|
|
4688
|
+
# @param application_id [string] (Optional) The application Id to search for identity providers.
|
|
4689
|
+
# @param name [string] (Optional) The name of the identity provider to search for. Supports wildcard search using *.
|
|
4690
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4691
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: enabled, id, insertInstant, name, type.
|
|
4692
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4693
|
+
# @param tenant_id [string] (Optional) The tenant Id to restrict the results to.
|
|
4694
|
+
# @param type [string] (Optional) The type of identity provider to search for.
|
|
4695
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4696
|
+
def search_identity_providers_by_parameters(application_id, name, number_of_results, order_by, start_row, tenant_id, type)
|
|
4697
|
+
start.uri('/api/identity-provider/search')
|
|
4698
|
+
.url_parameter('applicationId', application_id)
|
|
4699
|
+
.url_parameter('name', name)
|
|
4700
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4701
|
+
.url_parameter('orderBy', order_by)
|
|
4702
|
+
.url_parameter('startRow', start_row)
|
|
4703
|
+
.url_parameter('tenantId', tenant_id)
|
|
4704
|
+
.url_parameter('type', type)
|
|
4705
|
+
.get
|
|
4706
|
+
.go
|
|
4707
|
+
end
|
|
4708
|
+
|
|
4473
4709
|
#
|
|
4474
4710
|
# Searches keys with the specified criteria and pagination.
|
|
4475
4711
|
#
|
|
@@ -4482,6 +4718,28 @@ module FusionAuth
|
|
|
4482
4718
|
.go
|
|
4483
4719
|
end
|
|
4484
4720
|
|
|
4721
|
+
#
|
|
4722
|
+
# Searches keys with the specified criteria and pagination.
|
|
4723
|
+
#
|
|
4724
|
+
# @param algorithm [string] (Optional) The algorithm of the key to search for.
|
|
4725
|
+
# @param name [string] (Optional) The name of the key to search for. Supports wildcard search using *.
|
|
4726
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4727
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: algorithm, expiration, id, insertInstant, name, type.
|
|
4728
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4729
|
+
# @param type [string] (Optional) The type of key to search for. Supported values: EC, HMAC, OKP, RSA.
|
|
4730
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4731
|
+
def search_keys_by_parameters(algorithm, name, number_of_results, order_by, start_row, type)
|
|
4732
|
+
start.uri('/api/key/search')
|
|
4733
|
+
.url_parameter('algorithm', algorithm)
|
|
4734
|
+
.url_parameter('name', name)
|
|
4735
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4736
|
+
.url_parameter('orderBy', order_by)
|
|
4737
|
+
.url_parameter('startRow', start_row)
|
|
4738
|
+
.url_parameter('type', type)
|
|
4739
|
+
.get
|
|
4740
|
+
.go
|
|
4741
|
+
end
|
|
4742
|
+
|
|
4485
4743
|
#
|
|
4486
4744
|
# Searches lambdas with the specified criteria and pagination.
|
|
4487
4745
|
#
|
|
@@ -4618,6 +4876,28 @@ module FusionAuth
|
|
|
4618
4876
|
.go
|
|
4619
4877
|
end
|
|
4620
4878
|
|
|
4879
|
+
#
|
|
4880
|
+
# Searches webhooks with the specified criteria and pagination.
|
|
4881
|
+
#
|
|
4882
|
+
# @param description [string] (Optional) The description of the webhook to search for. Supports wildcard search using *.
|
|
4883
|
+
# @param number_of_results [Numeric] (Optional) The number of results to return. Defaults to 25.
|
|
4884
|
+
# @param order_by [string] (Optional) The field to order the results by. Supported values: description, id, insertInstant, url.
|
|
4885
|
+
# @param start_row [Numeric] (Optional) The offset into the total results. Defaults to 0.
|
|
4886
|
+
# @param tenant_id [string] (Optional) The tenant Id to restrict the results to.
|
|
4887
|
+
# @param url [string] (Optional) The URL of the webhook to search for. Supports wildcard search using *.
|
|
4888
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
4889
|
+
def search_webhooks_by_parameters(description, number_of_results, order_by, start_row, tenant_id, url)
|
|
4890
|
+
start.uri('/api/webhook/search')
|
|
4891
|
+
.url_parameter('description', description)
|
|
4892
|
+
.url_parameter('numberOfResults', number_of_results)
|
|
4893
|
+
.url_parameter('orderBy', order_by)
|
|
4894
|
+
.url_parameter('startRow', start_row)
|
|
4895
|
+
.url_parameter('tenantId', tenant_id)
|
|
4896
|
+
.url_parameter('url', url)
|
|
4897
|
+
.get
|
|
4898
|
+
.go
|
|
4899
|
+
end
|
|
4900
|
+
|
|
4621
4901
|
#
|
|
4622
4902
|
# Send an email using an email template Id. You can optionally provide <code>requestData</code> to access key value
|
|
4623
4903
|
# pairs in the email template.
|
|
@@ -4870,6 +5150,37 @@ module FusionAuth
|
|
|
4870
5150
|
.go
|
|
4871
5151
|
end
|
|
4872
5152
|
|
|
5153
|
+
#
|
|
5154
|
+
# Updates the CIMD domain with the given Id.
|
|
5155
|
+
#
|
|
5156
|
+
# @param domain_id [string] The Id of the CIMD domain to update.
|
|
5157
|
+
# @param request [OpenStruct, Hash] The request that contains all the new CIMD domain information.
|
|
5158
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
5159
|
+
def update_cimd_domain(domain_id, request)
|
|
5160
|
+
start.uri('/api/cimd/domain')
|
|
5161
|
+
.url_segment(domain_id)
|
|
5162
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
5163
|
+
.put
|
|
5164
|
+
.go
|
|
5165
|
+
end
|
|
5166
|
+
|
|
5167
|
+
#
|
|
5168
|
+
# Updates the OAuth scope with the given Id for the CIMD domain.
|
|
5169
|
+
#
|
|
5170
|
+
# @param domain_id [string] The Id of the CIMD domain that the OAuth scope belongs to.
|
|
5171
|
+
# @param scope_id [string] The Id of the OAuth scope to update.
|
|
5172
|
+
# @param request [OpenStruct, Hash] The request that contains all the new OAuth scope information.
|
|
5173
|
+
# @return [FusionAuth::ClientResponse] The ClientResponse object.
|
|
5174
|
+
def update_cimd_domain_o_auth_scope(domain_id, scope_id, request)
|
|
5175
|
+
start.uri('/api/cimd/domain')
|
|
5176
|
+
.url_segment(domain_id)
|
|
5177
|
+
.url_segment("scope")
|
|
5178
|
+
.url_segment(scope_id)
|
|
5179
|
+
.body_handler(FusionAuth::JSONBodyHandler.new(request))
|
|
5180
|
+
.put
|
|
5181
|
+
.go
|
|
5182
|
+
end
|
|
5183
|
+
|
|
4873
5184
|
#
|
|
4874
5185
|
# Updates the connector with the given Id.
|
|
4875
5186
|
#
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: fusionauth_client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.70.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Brian Pontarelli
|
|
8
8
|
- Daniel DeGroff
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: This library contains the Ruby client library that helps you connect
|
|
14
14
|
your application to FusionAuth.
|
|
@@ -23,6 +23,7 @@ files:
|
|
|
23
23
|
- ".github/fusionauth/.env"
|
|
24
24
|
- ".github/fusionauth/docker-compose.yml"
|
|
25
25
|
- ".github/fusionauth/kickstart.json"
|
|
26
|
+
- ".github/fusionauth/poll-for-kickstart-finish.sh"
|
|
26
27
|
- ".github/workflows/deploy.yaml"
|
|
27
28
|
- ".github/workflows/docs.yml"
|
|
28
29
|
- ".github/workflows/test.yml"
|
|
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
109
110
|
- !ruby/object:Gem::Version
|
|
110
111
|
version: '0'
|
|
111
112
|
requirements: []
|
|
112
|
-
rubygems_version: 3.6.
|
|
113
|
+
rubygems_version: 3.6.9
|
|
113
114
|
specification_version: 4
|
|
114
115
|
summary: The Ruby client library for FusionAuth
|
|
115
116
|
test_files: []
|