auth0 6.3.0 → 6.5.0

data/lib/auth0/client_profiles/client.rb

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module Auth0
+  module ClientProfiles
+    class Client
+      # @param client [Auth0::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve a paginated list of client profiles for the tenant. Uses checkpoint pagination: pass the
+      # <code>next</code> cursor from a previous response as the <code>from</code> query parameter to retrieve the
+      # following page.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :from
+      # @option params [Integer, nil] :take
+      #
+      # @example
+      #   client.client_profiles.list(
+      #     from: "from",
+      #     take: 1
+      #   )
+      #
+      # @return [Auth0::Types::ListClientProfilesPaginatedResponseContent]
+      def list(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["take"] = params.fetch(:take, 50)
+
+        Auth0::Internal::CursorItemIterator.new(
+          cursor_field: :next_,
+          item_field: :client_profiles,
+          initial_cursor: query_params["from"]
+        ) do |next_cursor|
+          query_params["from"] = next_cursor
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "client-profiles",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Auth0::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListClientProfilesPaginatedResponseContent.load(response.body))
+            [parsed_response, response]
+          else
+            error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+
+      # Create a client profile. At most one profile is allowed per tenant in this release; attempting to create a
+      # second returns <code>409 Conflict</code>. The profile governs Dynamic CIMD clients matched by its
+      # <code>apply_policy</code> at runtime.
+      #
+      # @param request_options [Hash]
+      # @param params [Auth0::ClientProfiles::Types::CreateClientProfileRequestContent]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.client_profiles.create(
+      #     name: "name",
+      #     client_configuration: {},
+      #     apply_policy: {
+      #       external_metadata_type: "cimd",
+      #       external_metadata_created_by: "client"
+      #     }
+      #   )
+      #
+      # @return [Auth0::Types::ClientProfile]
+      def create(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "client-profiles",
+          body: Auth0::ClientProfiles::Types::CreateClientProfileRequestContent.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Auth0::Types::ClientProfile.load(response.body))
+        else
+          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve a single client profile by its identifier. Returns <code>404</code> if no profile with the given ID
+      # exists for the tenant.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Auth0::Types::ClientProfileID] :id
+      #
+      # @example
+      #   client.client_profiles.get(id: "id")
+      #
+      # @return [Auth0::Types::ClientProfile]
+      def get(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "client-profiles/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Auth0::Types::ClientProfile.load(response.body))
+        else
+          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Delete a client profile. Idempotent: returns <code>204 No Content</code> whether or not a profile with the given
+      # ID existed. Deleting the profile removes fleet governance for matched clients immediately.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Auth0::Types::ClientProfileID] :id
+      #
+      # @example
+      #   client.client_profiles.delete(id: "id")
+      #
+      # @return [untyped]
+      def delete(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "client-profiles/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Update a client profile. Supports partial updates at the top level (JSON Merge Patch); omitted top-level fields
+      # remain unchanged. Nested objects such as <code>client_configuration</code> must be supplied in full.
+      #
+      # @param request_options [Hash]
+      # @param params [Auth0::ClientProfiles::Types::UpdateClientProfileRequestContent]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Auth0::Types::ClientProfileID] :id
+      #
+      # @example
+      #   client.client_profiles.update(id: "id")
+      #
+      # @return [Auth0::Types::ClientProfile]
+      def update(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        request_data = Auth0::ClientProfiles::Types::UpdateClientProfileRequestContent.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "client-profiles/#{URI.encode_uri_component(params[:id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Auth0::Types::ClientProfile.load(response.body))
+        else
+          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/client_profiles/types/create_client_profile_request_content.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Auth0
+  module ClientProfiles
+    module Types
+      class CreateClientProfileRequestContent < Internal::Types::Model
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :client_configuration, -> { Auth0::Types::ClientProfileClientConfiguration }, optional: false, nullable: false
+
+        field :apply_policy, -> { Auth0::Types::ClientProfileApplyPolicy }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/auth0/client_profiles/types/list_client_profiles_request_parameters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Auth0
+  module ClientProfiles
+    module Types
+      class ListClientProfilesRequestParameters < Internal::Types::Model
+        field :from, -> { String }, optional: true, nullable: false
+
+        field :take, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/auth0/client_profiles/types/update_client_profile_request_content.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Auth0
+  module ClientProfiles
+    module Types
+      class UpdateClientProfileRequestContent < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :client_configuration, -> { Auth0::Types::ClientProfileClientConfiguration }, optional: true, nullable: false
+
+        field :apply_policy, -> { Auth0::Types::ClientProfileApplyPolicy }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/auth0/clients/client.rb

@@ -257,6 +257,87 @@ module Auth0
         end
       end
 
+      # Search clients using SCIM or Lucene filter syntax with low-latency, eventually consistent results.
+      # Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene").
+      # This endpoint provides an alternative to the standard GET /clients endpoint with better performance
+      # for complex queries. Results may not reflect recent updates immediately.
+      #
+      # - This endpoint only supports `read:clients` and `read:client_summary` scopes. The `read:client_keys` and
+      # `read:client_credentials` scopes are not supported.
+      # - The following fields are never returned by this endpoint:
+      #   - `client_secret`
+      #   - `encryption_key`
+      #   - `signing_keys`
+      #   - `owners`
+      #   - `addons`
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :q
+      # @option params [Auth0::Types::SearchParserEnum, nil] :parser
+      # @option params [String, nil] :fields
+      # @option params [Boolean, nil] :include_fields
+      # @option params [Integer, nil] :take
+      # @option params [String, nil] :from
+      # @option params [Auth0::Types::ClientSortFieldEnum, nil] :sort
+      #
+      # @example
+      #   client.clients.search(
+      #     q: "q",
+      #     parser: "scim",
+      #     fields: "fields",
+      #     include_fields: true,
+      #     take: 1,
+      #     from: "from",
+      #     sort: "name"
+      #   )
+      #
+      # @return [Auth0::Types::SearchClientsResponseContent]
+      def search(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["q"] = params[:q] if params.key?(:q)
+        query_params["parser"] = params[:parser] if params.key?(:parser)
+        query_params["fields"] = params[:fields] if params.key?(:fields)
+        query_params["include_fields"] = params[:include_fields] if params.key?(:include_fields)
+        query_params["take"] = params.fetch(:take, 50)
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["sort"] = params[:sort] if params.key?(:sort)
+
+        Auth0::Internal::CursorItemIterator.new(
+          cursor_field: :next_,
+          item_field: :clients,
+          initial_cursor: query_params["from"]
+        ) do |next_cursor|
+          query_params["from"] = next_cursor
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "clients/search",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Auth0::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::SearchClientsResponseContent.load(response.body))
+            [parsed_response, response]
+          else
+            error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+
       # Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list
       # of fields to include or exclude may also be specified.
       # For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and

data/lib/auth0/clients/types/create_client_request_content.rb

@@ -108,6 +108,8 @@ module Auth0
 
         field :anonymous_sessions, -> { Auth0::Types::CreateAnonymousSessions }, optional: true, nullable: false
 
+        field :enforce_anon_session_transfer_network_binding, -> { Auth0::Types::ClientAnonymousSessionTransferNetworkBindingEnum }, optional: true, nullable: false
+
         field :third_party_security_mode, -> { Auth0::Types::ClientThirdPartySecurityModeEnum }, optional: true, nullable: false
 
         field :redirection_policy, -> { Auth0::Types::ClientRedirectionPolicyEnum }, optional: true, nullable: false
@@ -119,6 +121,8 @@ module Auth0
         field :my_organization_configuration, -> { Auth0::Types::ClientMyOrganizationPostConfiguration }, optional: true, nullable: false
 
         field :async_approval_notification_channels, -> { Internal::Types::Array[Auth0::Types::AsyncApprovalNotificationsChannelsEnum] }, optional: true, nullable: false
+
+        field :oidc_support, -> { Auth0::Types::ClientOidcSupportPost }, optional: true, nullable: false
       end
     end
   end

data/lib/auth0/clients/types/search_clients_request_parameters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Clients
+    module Types
+      class SearchClientsRequestParameters < Internal::Types::Model
+        field :q, -> { String }, optional: true, nullable: false
+
+        field :parser, -> { Auth0::Types::SearchParserEnum }, optional: true, nullable: false
+
+        field :fields, -> { String }, optional: true, nullable: false
+
+        field :include_fields, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :take, -> { Integer }, optional: true, nullable: false
+
+        field :from, -> { String }, optional: true, nullable: false
+
+        field :sort, -> { Auth0::Types::ClientSortFieldEnum }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/auth0/clients/types/update_client_request_content.rb

@@ -68,6 +68,8 @@ module Auth0
 
         field :anonymous_sessions, -> { Auth0::Types::UpdateAnonymousSessions }, optional: true, nullable: false
 
+        field :enforce_anon_session_transfer_network_binding, -> { Auth0::Types::ClientAnonymousSessionTransferNetworkBindingEnum }, optional: true, nullable: false
+
         field :form_template, -> { String }, optional: true, nullable: false
 
         field :addons, -> { Auth0::Types::ClientAddons }, optional: true, nullable: false
@@ -121,6 +123,8 @@ module Auth0
         field :third_party_security_mode, -> { Auth0::Types::ClientThirdPartySecurityModeEnum }, optional: true, nullable: false
 
         field :redirection_policy, -> { Auth0::Types::ClientRedirectionPolicyEnum }, optional: true, nullable: false
+
+        field :oidc_support, -> { Auth0::Types::ClientOidcSupportPatch }, optional: true, nullable: false
       end
     end
   end

data/lib/auth0/email_templates/client.rb

@@ -21,7 +21,14 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       #
       # @example
-      #   client.email_templates.create(template: "verify_email")
+      #   client.email_templates.create(
+      #     template: "verify_email",
+      #     body: nil,
+      #     from: nil,
+      #     subject: nil,
+      #     syntax: nil,
+      #     enabled: nil
+      #   )
       #
       # @return [Auth0::Types::CreateEmailTemplateResponseContent]
       def create(request_options: {}, **params)
@@ -101,7 +108,12 @@ module Auth0
       # @example
       #   client.email_templates.set(
       #     template_name: "verify_email",
-      #     template: "verify_email"
+      #     template: "verify_email",
+      #     body: nil,
+      #     from: nil,
+      #     subject: nil,
+      #     syntax: nil,
+      #     enabled: nil
       #   )
       #
       # @return [Auth0::Types::SetEmailTemplateResponseContent]

data/lib/auth0/experimentation/client.rb

@@ -14,6 +14,16 @@ module Auth0
       def experiments
         @experiments ||= Auth0::Experimentation::Experiments::Client.new(client: @client)
       end
+
+      # @return [Auth0::FeatureFlags::Client]
+      def feature_flags
+        @feature_flags ||= Auth0::Experimentation::FeatureFlags::Client.new(client: @client)
+      end
+
+      # @return [Auth0::Segments::Client]
+      def segments
+        @segments ||= Auth0::Experimentation::Segments::Client.new(client: @client)
+      end
     end
   end
 end