fusionauth_client 1.22.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c8c1a50df83ef803ec50ec990b0118e9f59477d4d55658276a83f0af609ac1
-  data.tar.gz: fef76faf3cec4d2c7a50e997ad08357af949bc974d9c35b96e88ecaf886acd30
+  metadata.gz: 61ebe66291227393968cfd972f5668175aca99e0780bc45f5b69b17b99524a82
+  data.tar.gz: 5579794527c8a3dfa909779b714cfe76c6f95e4561c8a01801d7b91595e45f47
 SHA512:
-  metadata.gz: 312c6a9bd86ab513ca2be344bc9ad5fb616c58eb51382f22737c3b69c22a8678d1175c94fd0aef7df71b31754509b0e78fa7ccc9b3102dd3b5938d90aa95d11c
-  data.tar.gz: 42817bd2972014e153b7cfb38b725c5051f89a50493e8277ff2a19f59219747494222b833d9c2d7e69498f55d6e6c3c70170793541cf8fe97466616e6d701b7c
+  metadata.gz: f925ced42b1e203af544a548260e120c944fede38dcaf9d785d5c59ee0ed7f3093044a8662136618e2c44d3e5815ba1be815a11c117d1b5e8b6bd4ef1b88d8a3
+  data.tar.gz: a120d54a3319323474804b9514198dd05bf459c5eca9ffbffb57d710dfd7e3cfa98e99e457d7b306d4d27aac8e6131e2c5b24b9d65de4a1eff3c7c8d797fd35c

data/README.md

@@ -59,12 +59,19 @@ response = client.login({
 user = response.success.response.user
 ```
 
-## Contributing
+## Questions and support
+
+If you have a question or support issue regarding this client library, we'd love to hear from you.
+
+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/).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-ruby-client.
 
 ## License
 
-The gem is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).
+This code is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).
 

data/build.savant

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

data/fusionauth-ruby-client.iml

@@ -8,8 +8,36 @@
     </content>
     <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, rbenv: 2.5.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
   </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build fusionauth_client-1.24.1.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.24.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install fusionauth_client-1.24.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v1.24.1 and build and push fusionauth_client-1.24.1.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

@@ -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.22.0'
+  spec.version       = '1.25.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -1844,7 +1844,7 @@ module FusionAuth
     #
     # Retrieves the identity provider for the given id or all of the identity providers if the id is null.
     #
-    # @param identity_provider_id [string] (Optional) The identity provider id.
+    # @param identity_provider_id [string] The identity provider Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_identity_provider(identity_provider_id)
       start.uri('/api/identity-provider')
@@ -1853,6 +1853,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single 
+    # identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request 
+    # may return multiple identity providers.
+    #
+    # @param type [OpenStruct, Hash] The type of the identity provider.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_identity_provider_by_type(type)
+      start.uri('/api/identity-provider')
+          .url_parameter('type', type)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves all of the identity providers.
     #
@@ -2119,6 +2133,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
+    #
+    # @param user_id [string] The Id of the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_refresh_token_by_id(user_id)
+      start.uri('/api/jwt/refresh')
+          .url_segment(user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the refresh tokens that belong to the user with the given Id.
     #
@@ -2484,8 +2510,30 @@ module FusionAuth
     end
 
     #
-    # Revokes a single refresh token, all tokens for a user or all tokens for an application. If you provide a user id
-    # and an application id, this will delete all the refresh tokens for that user for that application.
+    # Revokes refresh tokens.
+    # 
+    # Usage examples:
+    #   - Delete a single refresh token, pass in only the token.
+    #       revokeRefreshToken(token)
+    # 
+    #   - Delete all refresh tokens for a user, pass in only the userId.
+    #       revokeRefreshToken(null, userId)
+    # 
+    #   - Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId.
+    #       revokeRefreshToken(null, userId, applicationId)
+    # 
+    #   - Delete all refresh tokens for an application
+    #       revokeRefreshToken(null, null, applicationId)
+    # 
+    # Note: <code>null</code> may be handled differently depending upon the programming language.
+    # 
+    # See also: (method names may vary by language... but you'll figure it out)
+    # 
+    #  - revokeRefreshTokenById
+    #  - revokeRefreshTokenByToken
+    #  - revokeRefreshTokensByUserId
+    #  - revokeRefreshTokensByApplicationId
+    #  - revokeRefreshTokensByUserIdForApplication
     #
     # @param token [string] (Optional) The refresh token to delete.
     # @param user_id [string] (Optional) The user id whose tokens to delete.
@@ -2500,6 +2548,68 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
+    #
+    # @param token_id [string] The unique Id of the token to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_token_by_id(token_id)
+      start.uri('/api/jwt/refresh')
+          .url_segment(token_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so  be careful with this API request.
+    #
+    # @param token [string] The refresh token to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_token_by_token(token)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('token', token)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to an application by applicationId.
+    #
+    # @param application_id [string] The unique Id of the application that you want to delete all refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_application_id(application_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('applicationId', application_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to a user by user Id.
+    #
+    # @param user_id [string] The unique Id of the user that you want to delete all refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_user_id(user_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('userId', user_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
+    #
+    # @param user_id [string] The unique Id of the user that you want to delete all refresh tokens for.
+    # @param application_id [string] The unique Id of the application that you want to delete refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_user_id_for_application(user_id, application_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('userId', user_id)
+          .url_parameter('applicationId', application_id)
+          .delete()
+          .go()
+    end
+
     #
     # Revokes a single User consent by Id.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.