fusionauth_client 1.39.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a9f230af6ca7349f8fdee665b8ba23985c385637d9d64d5c355ffdf5bc77c6
-  data.tar.gz: c24e551fa66cbcd3621062f93204422acde7bdadd0b4f9a6884635cb756c65f7
+  metadata.gz: 4d7a14c355dc44a349a38f749dc8ffe085129d6d1bccfa5799be45968cc00f45
+  data.tar.gz: 29fb4471d770b6b396424000c285b875e1204704cd09056bccb1ebed0b60e9f9
 SHA512:
-  metadata.gz: d5f95f92365e882fff1753ec87d4302f5933617f72c7faefe8decc9cd877b3e7f83ab785b507ba64f8b7244889982cc0f8c0ec6f4ddcf929a920504e017b1415
-  data.tar.gz: 30373ef50dd2fbc08020781e77d9ec8a03d96f0bce02f41ad8c3a2a01b9ebe9c025b0d90795e977bbc4b9f9c8f0e5f39bb6723920ed59d8d3a455de85a729c41
+  metadata.gz: 064ce98e40306be0049f7c715533d52d8e9b4c8c1bfe2502093cbde9e8d797c08bef2471e75ca84ab167facc6e3f2ced85ee54d3c69ae5340adcda62f89c0e39
+  data.tar.gz: 07f3b6aaf676a468eeea4d9c758fa547a54d49e8062128209c432e1dfb99b30e61735cba55340df4afd5b8e65f9210558ec60d152b7f792f24a375c75dfff64e

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.39.0)
+    fusionauth_client (1.42.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.39.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.42.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()
@@ -40,8 +39,8 @@ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.39.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.39.0'
-  spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
-  spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
+  spec.name = 'fusionauth_client'
+  spec.version = '1.42.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.
     #
@@ -1123,11 +1191,11 @@ module FusionAuth
     end
 
     #
-    # Disable Two Factor authentication for a user.
+    # Disable two-factor authentication for a user.
     #
-    # @param user_id [string] The Id of the User for which you're disabling Two Factor authentication.
+    # @param user_id [string] The Id of the User for which you're disabling two-factor authentication.
     # @param method_id [string] The two-factor method identifier you wish to disable
-    # @param code [string] The Two Factor code used verify the the caller knows the Two Factor secret.
+    # @param code [string] The two-factor code used verify the the caller knows the two-factor secret.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def disable_two_factor(user_id, method_id, code)
       start.uri('/api/user/two-factor')
@@ -1139,9 +1207,9 @@ module FusionAuth
     end
 
     #
-    # Disable Two Factor authentication for a user using a JSON body rather than URL parameters.
+    # Disable two-factor authentication for a user using a JSON body rather than URL parameters.
     #
-    # @param user_id [string] The Id of the User for which you're disabling Two Factor authentication.
+    # @param user_id [string] The Id of the User for which you're disabling two-factor authentication.
     # @param request [OpenStruct, Hash] The request information that contains the code and methodId along with any event information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def disable_two_factor_with_request(user_id, request)
@@ -1153,10 +1221,10 @@ module FusionAuth
     end
 
     #
-    # Enable Two Factor authentication for a user.
+    # Enable two-factor authentication for a user.
     #
-    # @param user_id [string] The Id of the user to enable Two Factor authentication.
-    # @param request [OpenStruct, Hash] The two factor enable request information.
+    # @param user_id [string] The Id of the user to enable two-factor authentication.
+    # @param request [OpenStruct, Hash] The two-factor enable request information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def enable_two_factor(user_id, request)
       start.uri('/api/user/two-factor')
@@ -1171,7 +1239,7 @@ module FusionAuth
     # Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
     #
     # @param code [string] The authorization code returned on the /oauth2/authorize response.
-    # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate.
+    # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
     # @param client_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled.
     # @param redirect_uri [string] The URI to redirect to upon a successful request.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -1194,7 +1262,7 @@ module FusionAuth
     # Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
     #
     # @param code [string] The authorization code returned on the /oauth2/authorize response.
-    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param redirect_uri [string] The URI to redirect to upon a successful request.
     # @param code_verifier [string] The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
@@ -1219,7 +1287,7 @@ module FusionAuth
     # If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
     #
     # @param refresh_token [string] The refresh token that you would like to use to exchange for an access token.
-    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     # @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
@@ -1257,7 +1325,7 @@ module FusionAuth
     #
     # @param username [string] The login identifier of the user. The login identifier can be either the email or the username.
     # @param password [string] The user’s password.
-    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     # @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
@@ -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.
     #
@@ -3684,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.39.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-11 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.