fusionauth_client 1.38.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf2c4810a2d7c274cda24502f66fdca37b188a74e8799417cc549d9c06e23a0
-  data.tar.gz: b5aa5629f7120d7d4983de81bfddfc4127c0194a2061f1ed11366ab4820bf73d
+  metadata.gz: 1b267a3d6f8f3a00b68ac5727b783b756fef5fecffbe961fef3c3598255186a0
+  data.tar.gz: 69de43665a4b212dc29ec957203b6cc9ac38cb143f21b60ac68cd0b93d6336fc
 SHA512:
-  metadata.gz: 36e2fb473ac870bd0f8b99a7c513c24bf60459d44e0b6dfc2eec1cad7cbb2ac3118e18df5b1df86ff2ffb151e4a55535e67e9c04a9ff5f587385ac145e2bffa9
-  data.tar.gz: a6ba3e7aca263497406c858e66faedc98405334015bf0b8a9f5a36fb807564afe996fceeb3ad4381648345f5d09e81ad881b1c8730dd828e2ffef388c13d919d
+  metadata.gz: e47bfe9d82626e71a2a48e87d5c7add7e79244b780e404954629644f465c95afa9fe05356707393ff06f17120164cb96a6311c59bda27634f2d107eb1c5dce2a
+  data.tar.gz: '092c4e6154b7704114a28c76ab03873282333067e79fb322db51f90f92d2cfc8f8c3c174c0cabdfd31c23f288c6d64e06e810dd405db03109ca274009701b9ca'

data/Gemfile

@@ -1,4 +1,4 @@
-# Copyright (c) 2019, FusionAuth, All Rights Reserved
+# Copyright (c) 2019-2022, FusionAuth, All Rights Reserved
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,8 +15,8 @@
 source 'https://rubygems.org'
 ruby '2.5.9'
 
-gem "rake",  "12.3.3"
-gem "minitest",  "5.8.3"
+gem "rake", "12.3.3"
+gem "minitest", "5.8.3"
 
 # Specify your gem's dependencies in fusionauth_client.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.38.0)
+    fusionauth_client (1.41.0)
 
 GEM
   remote: https://rubygems.org/

data/build.savant

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2020, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2022, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,10 +13,9 @@
  * either express or implied. See the License for the specific
  * language governing permissions and limitations under the License.
  */
-savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.38.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.41.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()
@@ -40,8 +39,8 @@ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.38.0
 }
 
 // Plugins
-file = loadPlugin(id: "org.savantbuild.plugin:file:1.0.2")
-release = loadPlugin(id: "org.savantbuild.plugin:release-git:${savantVersion}")
+file = loadPlugin(id: "org.savantbuild.plugin:file:2.0.0-RC.4")
+release = loadPlugin(id: "org.savantbuild.plugin:release-git:2.0.0-RC.4")
 
 target(name: "clean", description: "Cleans build directory") {
   file.prune(dir: 'pkg')

data/fusionauth-ruby-client.iml

@@ -12,32 +12,4 @@
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.9) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.9) [gem]" level="application" />
   </component>
-  <component name="RakeTasksCache">
-    <option name="myRootTask">
-      <RakeTaskImpl id="rake">
-        <subtasks>
-          <RakeTaskImpl description="Build fusionauth_client-1.37.0.gem into the pkg directory" fullCommand="build" id="build" />
-          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
-          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install fusionauth_client-1.37.0.gem into system gems" fullCommand="install" id="install" />
-          <RakeTaskImpl id="install">
-            <subtasks>
-              <RakeTaskImpl description="Build and install fusionauth_client-1.37.0.gem into system gems without network access" fullCommand="install:local" id="local" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v1.37.0 and build and push fusionauth_client-1.37.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
-          <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
-          <RakeTaskImpl description="" fullCommand="default" id="default" />
-          <RakeTaskImpl description="" fullCommand="release" id="release" />
-          <RakeTaskImpl id="release">
-            <subtasks>
-              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
-              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
-              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
-            </subtasks>
-          </RakeTaskImpl>
-        </subtasks>
-      </RakeTaskImpl>
-    </option>
-  </component>
 </module>

data/fusionauth_client.gemspec

@@ -1,17 +1,32 @@
 # coding: utf-8
+
+# Copyright (c) 2022, FusionAuth, All Rights Reserved
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+# either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = 'fusionauth_client'
-  spec.version       = '1.38.0'
-  spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
-  spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
+  spec.name = 'fusionauth_client'
+  spec.version = '1.41.0'
+  spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
+  spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
 
-  spec.summary       = %q{The Ruby client library for FusionAuth}
-  spec.description   = %q{This library contains the Ruby client library that helps you connect your application to FusionAuth.}
-  spec.homepage      = 'https://github.com/FusionAuth/fusionauth-ruby-client'
-  spec.license       = 'Apache-2.0'
+  spec.summary = %q{The Ruby client library for FusionAuth}
+  spec.description = %q{This library contains the Ruby client library that helps you connect your application to FusionAuth.}
+  spec.homepage = 'https://github.com/FusionAuth/fusionauth-ruby-client'
+  spec.license = 'Apache-2.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -21,11 +36,11 @@ Gem::Specification.new do |spec|
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   # spec.add_development_dependency 'bundler', '~> 1.14'

data/lib/fusionauth/fusionauth_client.rb

@@ -175,6 +175,26 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Make a Client Credentials grant request to obtain an access token.
+    #
+    # @param client_id [string] The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
+    # @param client_secret [string] The client secret used to authenticate this request.
+    # @param scope [string] (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:<target-entity-id>:<roles>. Roles are an optional comma separated list.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def client_credentials_grant(client_id, client_secret, scope)
+      body = {
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "grant_type" => "client_credentials",
+        "scope" => scope
+      }
+      startAnonymous.uri('/oauth2/token')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Adds a comment to the user's account.
     #
@@ -187,6 +207,42 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for completing the authentication ceremony
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def complete_web_authn_assertion(request)
+      startAnonymous.uri('/api/webauthn/assert')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge and then login the user in
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for completing the authentication ceremony
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def complete_web_authn_login(request)
+      startAnonymous.uri('/api/webauthn/login')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Complete a WebAuthn registration ceremony by validating the client request and saving the new credential
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for completing the registration ceremony
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def complete_web_authn_registration(request)
+      start.uri('/api/webauthn/register/complete')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated.
     # an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted 
@@ -1110,6 +1166,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the WebAuthn credential for the given Id.
+    #
+    # @param id [string] The Id of the WebAuthn credential to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_web_authn_credential(id)
+      start.uri('/api/webauthn')
+          .url_segment(id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the webhook for the given Id.
     #
@@ -1438,6 +1506,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Import a WebAuthn credential
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for importing the credential
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def import_web_authn_credential(request)
+      start.uri('/api/webauthn/import')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Inspect an access token issued by FusionAuth.
     #
@@ -3230,6 +3310,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the WebAuthn credential for the given Id.
+    #
+    # @param id [string] The Id of the WebAuthn credential.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_web_authn_credential(id)
+      start.uri('/api/webauthn')
+          .url_segment(id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all WebAuthn credentials for the given user.
+    #
+    # @param user_id [string] The user's ID.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_web_authn_credentials_for_user(user_id)
+      start.uri('/api/webauthn')
+          .url_parameter('userId', user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
     #
@@ -3462,6 +3566,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches groups with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_groups(request)
+      start.uri('/api/group/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches the IP Access Control Lists with the specified criteria and pagination.
     #
@@ -3672,6 +3788,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Start a WebAuthn authentication ceremony by generating a new challenge for the user
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for starting the authentication ceremony
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def start_web_authn_login(request)
+      start.uri('/api/webauthn/start')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Start a WebAuthn registration ceremony by generating a new challenge for the user
+    #
+    # @param request [OpenStruct, Hash] An object containing data necessary for starting the registration ceremony
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def start_web_authn_registration(request)
+      start.uri('/api/webauthn/register/start')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Complete login using a 2FA challenge
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.38.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.