fusionauth_client 1.18.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21109a2d8e1bd5cb1229077c02415245b6f04574e91f05240cce4ad5900eb0eb
-  data.tar.gz: 971f1406ab820d744161bebaf1d427c665963789dd129bac32b092c05d8816ac
+  metadata.gz: 19c8c1a50df83ef803ec50ec990b0118e9f59477d4d55658276a83f0af609ac1
+  data.tar.gz: fef76faf3cec4d2c7a50e997ad08357af949bc974d9c35b96e88ecaf886acd30
 SHA512:
-  metadata.gz: be173c20a7f84ce6c0155c6a6d3cbcdfc7114fde73b7698bbc61f3fa18731a55db4418ca8c2a42efa50b9bacda58726d0668d724bcdc6bac87ec8741dfcca3a4
-  data.tar.gz: 5c3f0faa5560a56daf6a4ee2bee68c448896ee529fab405507a258669f99d3a91e0430c12056ed76d9345978b5ff62db47243931e683769d041a7be82864dd7b
+  metadata.gz: 312c6a9bd86ab513ca2be344bc9ad5fb616c58eb51382f22737c3b69c22a8678d1175c94fd0aef7df71b31754509b0e78fa7ccc9b3102dd3b5938d90aa95d11c
+  data.tar.gz: 42817bd2972014e153b7cfb38b725c5051f89a50493e8277ff2a19f59219747494222b833d9c2d7e69498f55d6e6c3c70170793541cf8fe97466616e6d701b7c

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 .rakeTasks
-/build
+/build
+**/.DS_Store

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.18.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.22.0", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth_client.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fusionauth_client'
-  spec.version       = '1.18.0'
+  spec.version       = '1.22.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -652,6 +652,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the tenant for the given Id asynchronously.
+    # This method is helpful if you do not want to wait for the delete operation to complete.
+    #
+    # @param tenant_id [string] The Id of the tenant to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_tenant_async(tenant_id)
+      start.uri('/api/tenant')
+          .url_segment(tenant_id)
+          .url_parameter('async', true)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the theme for the given Id.
     #
@@ -779,11 +793,11 @@ module FusionAuth
 
     #
     # Exchanges an OAuth authorization code for an access token.
-    # If you will be using the Authorization Code grant, you will make a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
+    # 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] (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_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
+    # @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_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.
     def exchange_o_auth_code_for_access_token(code, client_id, client_secret, redirect_uri)
@@ -800,6 +814,31 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Exchanges an OAuth authorization code and code_verifier for an access token.
+    # 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_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.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def exchange_o_auth_code_for_access_token_using_pkce(code, client_id, client_secret, redirect_uri, code_verifier)
+      body = {
+        "code" => code,
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "grant_type" => "authorization_code",
+        "redirect_uri" => redirect_uri,
+        "code_verifier" => code_verifier
+      }
+      startAnonymous.uri('/oauth2/token')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Exchange a Refresh Token for an Access Token.
     # 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.
@@ -940,8 +979,8 @@ module FusionAuth
     # @param encoded_jwt [string] The encoded JWT (access token).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def generate_two_factor_secret_using_jwt(encoded_jwt)
-      start.uri('/api/two-factor/secret')
-          .authorization('JWT ' + encoded_jwt)
+      startAnonymous.uri('/api/two-factor/secret')
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end
@@ -975,9 +1014,33 @@ module FusionAuth
     end
 
     #
-    # Bulk imports multiple users. This does some validation, but then tries to run batch inserts of users. This reduces
-    # latency when inserting lots of users. Therefore, the error response might contain some information about failures,
-    # but it will likely be pretty generic.
+    # Bulk imports refresh tokens. This request performs minimal validation and runs batch inserts of refresh tokens with the
+    # expectation that each token represents a user that already exists and is registered for the corresponding FusionAuth
+    # Application. This is done to increases the insert performance.
+    # 
+    # Therefore, if you encounter an error due to a database key violation, the response will likely offer a generic
+    # explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
+    # body with specific validation errors. This will slow the request down but will allow you to identify the cause of
+    # the failure. See the validateDbConstraints request parameter.
+    #
+    # @param request [OpenStruct, Hash] The request that contains all of the information about all of the refresh tokens to import.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def import_refresh_tokens(request)
+      start.uri('/api/user/refresh-token/import')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Bulk imports users. This request performs minimal validation and runs batch inserts of users with the expectation
+    # that each user does not yet exist and each registration corresponds to an existing FusionAuth Application. This is done to
+    # increases the insert performance.
+    # 
+    # Therefore, if you encounter an error due to a database key violation, the response will likely offer
+    # a generic explanation. If you encounter an error, you may optionally enable additional validation to receive a JSON response
+    # body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See
+    # the validateDbConstraints request parameter.
     #
     # @param request [OpenStruct, Hash] The request that contains all of the information about all of the users to import.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -988,6 +1051,23 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Inspect an access token issued by FusionAuth.
+    #
+    # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.
+    # @param token [string] The access token returned by this OAuth provider as the result of a successful authentication.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def introspect_access_token(client_id, token)
+      body = {
+        "client_id" => client_id,
+        "token" => token
+      }
+      startAnonymous.uri('/oauth2/introspect')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid
     # access token is properly signed and not expired.
@@ -998,12 +1078,12 @@ module FusionAuth
     # @param application_id [string] The Application Id for which you are requesting a new access token be issued.
     # @param encoded_jwt [string] The encoded JWT (access token).
     # @param refresh_token [string] (Optional) An existing refresh token used to request a refresh token in addition to a JWT in the response.
-    #     <p>The target application represented by the applicationid request parameter must have refresh 
+    #     <p>The target application represented by the applicationId request parameter must have refresh
     #     tokens enabled in order to receive a refresh token in the response.</p>
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def issue_jwt(application_id, encoded_jwt, refresh_token)
-      start.uri('/api/jwt/issue')
-          .authorization('JWT ' + encoded_jwt)
+      startAnonymous.uri('/api/jwt/issue')
+          .authorization('Bearer ' + encoded_jwt)
           .url_parameter('applicationId', application_id)
           .url_parameter('refreshToken', refresh_token)
           .get()
@@ -1447,6 +1527,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Re-sends the verification email to the user. If the Application has configured a specific email template this will be used
+    # instead of the tenant configuration.
+    #
+    # @param application_id [string] The unique Application Id to used to resolve an application specific email template.
+    # @param email [string] The email address of the user that needs a new verification email.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def resend_email_verification_with_application_template(application_id, email)
+      start.uri('/api/user/verify-email')
+          .url_parameter('applicationId', application_id)
+          .url_parameter('email', email)
+          .put()
+          .go()
+    end
+
     #
     # Re-sends the application registration verification email to the user.
     #
@@ -2288,6 +2383,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Call the UserInfo endpoint to retrieve User Claims from the access token issued by FusionAuth.
+    #
+    # @param encoded_jwt [string] The encoded JWT (access token).
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_info_from_access_token(encoded_jwt)
+      startAnonymous.uri('/oauth2/userinfo')
+          .authorization('Bearer ' + encoded_jwt)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
     # login counts for that application.
@@ -2349,7 +2456,7 @@ module FusionAuth
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_user_using_jwt(encoded_jwt)
       startAnonymous.uri('/api/user')
-          .authorization('JWT ' + encoded_jwt)
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end
@@ -2912,7 +3019,7 @@ module FusionAuth
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def validate_jwt(encoded_jwt)
       startAnonymous.uri('/api/jwt/validate')
-          .authorization('JWT ' + encoded_jwt)
+          .authorization('Bearer ' + encoded_jwt)
           .get()
           .go()
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Brian Pontarelli
 - Daniel DeGroff
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -36,7 +36,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The Ruby client library for FusionAuth
 test_files: []