Sha256: f4d6262d8701ab351442e760d7c3ab7d847198e4e373df61fba2f2d1d86e705b

Contents?: true

Size: 1.43 KB

Versions: 41

Compression:

Stored size: 1.43 KB

Contents

module Auth0
  module Api
    module V2
      # Methods to use the blacklist endpoints
      module Blacklists
        attr_reader :blacklists_path

        # Retrieves the jti and aud of all tokens in the blacklist.
        # @see https://auth0.com/docs/api/v2#!/Blacklists/get_tokens
        # @param aud [string] The JWT's aud claim. The client_id of the client for which it was issued
        #
        # @return [json] Returns the blacklisted tokens
        #
        def blacklisted_tokens(aud = nil)
          request_params = {
            aud: aud
          }
          get(blacklists_path, request_params)
        end

        # Adds the token identified by the jti to a blacklist for the tenant.
        # @see https://auth0.com/docs/api/v2#!/blacklists/post_tokens
        # @param jti [string] The jti of the JWT to blacklist
        # @param aud [string] The JWT's aud claim. The client_id of the client for which it was issued
        # @return [json] Returns the blacklisted token
        #
        def add_token_to_blacklist(jti, aud = nil)
          raise Auth0::MissingParameter, 'Must specify a valid JTI' if jti.to_s.empty?
          request_params = {
            jti: jti,
            aud: aud
          }
          post(blacklists_path, request_params)
        end

        private

        # Blacklists API path
        def blacklists_path
          @blacklists_path ||= '/api/v2/blacklists/tokens'
        end
      end
    end
  end
end

Version data entries

41 entries across 41 versions & 1 rubygems

Version Path
auth0-5.18.0 lib/auth0/api/v2/blacklists.rb
auth0-5.16.0 lib/auth0/api/v2/blacklists.rb
auth0-5.15.0 lib/auth0/api/v2/blacklists.rb
auth0-5.14.2 lib/auth0/api/v2/blacklists.rb
auth0-5.14.1 lib/auth0/api/v2/blacklists.rb
auth0-5.14.0 lib/auth0/api/v2/blacklists.rb
auth0-5.13.0 lib/auth0/api/v2/blacklists.rb
auth0-5.12.0 lib/auth0/api/v2/blacklists.rb
auth0-5.11.0 lib/auth0/api/v2/blacklists.rb
auth0-5.10.0 lib/auth0/api/v2/blacklists.rb
auth0-5.9.0 lib/auth0/api/v2/blacklists.rb
auth0-5.8.1 lib/auth0/api/v2/blacklists.rb
auth0-5.8.0 lib/auth0/api/v2/blacklists.rb
auth0-5.7.0 lib/auth0/api/v2/blacklists.rb
auth0-5.6.1 lib/auth0/api/v2/blacklists.rb
auth0-5.6.0 lib/auth0/api/v2/blacklists.rb
auth0-5.5.0 lib/auth0/api/v2/blacklists.rb
auth0-5.4.0 lib/auth0/api/v2/blacklists.rb
auth0-5.3.0 lib/auth0/api/v2/blacklists.rb
auth0-5.2.0 lib/auth0/api/v2/blacklists.rb