Sha256: 3c6e0b230ff81c9ac0e8c9b3e747108af1d5a5f777475c3894c72e052f33bb86

Contents?: true

Size: 1.37 KB

Versions: 41

Compression:

Stored size: 1.37 KB

Contents

module Auth0
  module Api
    module V2
      # Methods to use the Tenants endpoints
      module Tenants
        attr_reader :tenant_path

        # Gets tenants settings.
        # @see https://auth0.com/docs/api/v2#!/Tenants/get_settings
        # @param fields [string] A comma separated list of fields to include or exclude from the result.
        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
        #
        # @return [json] Returns tenants settings.
        def get_tenant_settings(fields: nil, include_fields: true)
          request_params = {
            fields: fields,
            include_fields: include_fields
          }
          get(tenant_path, request_params)
        end

        # Updates tenants settings.
        # @see https://auth0.com/docs/api/v2#!/Tenants/patch_settings
        # @param body [hash] The Hash body used to define the tenant settings' values.
        #
        # @return [json] Returns the updated tenant settings.
        def update_tenant_settings(body)
          raise Auth0::InvalidParameter, 'Must supply a valid body to update tenant settings' if body.to_s.empty?
          patch(tenant_path, body)
        end

        private

        # Tenants settings API path
        def tenant_path
          @tenant_path ||= '/api/v2/tenants/settings'
        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/tenants.rb
auth0-5.16.0 lib/auth0/api/v2/tenants.rb
auth0-5.15.0 lib/auth0/api/v2/tenants.rb
auth0-5.14.2 lib/auth0/api/v2/tenants.rb
auth0-5.14.1 lib/auth0/api/v2/tenants.rb
auth0-5.14.0 lib/auth0/api/v2/tenants.rb
auth0-5.13.0 lib/auth0/api/v2/tenants.rb
auth0-5.12.0 lib/auth0/api/v2/tenants.rb
auth0-5.11.0 lib/auth0/api/v2/tenants.rb
auth0-5.10.0 lib/auth0/api/v2/tenants.rb
auth0-5.9.0 lib/auth0/api/v2/tenants.rb
auth0-5.8.1 lib/auth0/api/v2/tenants.rb
auth0-5.8.0 lib/auth0/api/v2/tenants.rb
auth0-5.7.0 lib/auth0/api/v2/tenants.rb
auth0-5.6.1 lib/auth0/api/v2/tenants.rb
auth0-5.6.0 lib/auth0/api/v2/tenants.rb
auth0-5.5.0 lib/auth0/api/v2/tenants.rb
auth0-5.4.0 lib/auth0/api/v2/tenants.rb
auth0-5.3.0 lib/auth0/api/v2/tenants.rb
auth0-5.2.0 lib/auth0/api/v2/tenants.rb