auth0 4.4.0 → 5.1.2

data/lib/auth0/api/v2/branding.rb

@@ -0,0 +1,66 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the branding endpoints
+      module Branding
+        attr_reader :branding_path
+
+        # Retrieve branding settings.
+        # @see https://auth0.com/docs/api/management/v2/#!/Branding/get_branding
+        #
+        # @return [json] Returns branding settings.
+        def branding()
+          get(branding_path)
+        end
+        alias get_branding branding
+
+        # Update branding settings.
+        # @see https://auth0.com/docs/api/management/v2/#!/Branding/patch_branding
+        # @param body [hash] the branding settings to update
+        #
+        # @return [json] Returns branding settings.
+        def patch_branding(body = {})
+          patch(branding_path, body)
+        end
+        alias update_branding patch_branding
+
+        # Get template for New Universal Login Experience
+        # @see https://auth0.com/docs/api/management/v2/#!/Branding/get_universal_login
+        #
+        # @return [json] Returns branding settings.
+        def branding_templates_for_universal_login
+          get(templates_path)
+        end
+        alias get_branding_templates_for_universal_login branding_templates_for_universal_login
+
+        # Delete template for New Universal Login Experience
+        # @see https://auth0.com/docs/api/management/v2/#!/Branding/delete_universal_login
+        # @param rule_id [string] The id of the rule to delete.
+        def delete_branding_templates_for_universal_login
+          delete(templates_path)
+        end
+
+        # Set template for New Universal Login Experience
+        # @see https://auth0.com/docs/api/management/v2/#!/Branding/put_universal_login
+        # @param body [hash] the branding settings to update
+        #
+        # @return [json] Returns branding settings.
+        def put_branding_templates_for_universal_login(body = {})
+          put(templates_path, body)
+        end
+        alias set_branding_templates_for_universal_login put_branding_templates_for_universal_login
+
+        private
+
+        # Branding API path
+        def branding_path
+          @branding_path ||= '/api/v2/branding'
+        end
+
+        def templates_path
+          @templates_path ||= "#{branding_path}/templates/universal-login"
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/client_grants.rb

@@ -7,10 +7,19 @@ module Auth0
 
         # Retrieves a list of all client grants.
         # @see https://auth0.com/docs/api/management/v2#!/client_grants/get_client_grants
-        #
+        # @param client_id [string] The client_id of the client grant to retrieve.
+        # @param audience [string] The audience of the client grant to retrieve.
+        # @param page [int] Page number to get, 0-based.
+        # @param per_page [int] Results per page if also passing a page number.
         # @return [json] Returns the client grants.
-        def client_grants
-          get(client_grants_path)
+        def client_grants (client_id: nil, audience: nil, page: nil, per_page: nil)
+          request_params = {
+            client_id: client_id,
+            audience: audience,
+            page: page,
+            per_page: per_page
+          }
+          get(client_grants_path, request_params)
         end
         alias get_all_client_grants client_grants
 
@@ -26,7 +35,7 @@ module Auth0
 
         # Deletes a client grant given its id.
         # @see https://auth0.com/docs/api/management/v2#!/client_grants/delete_client_grants_by_id
-        # @param client_id [string] The id of the client grant to delete.
+        # @param client_grant_id [string] The id of the client grant to delete.
         def delete_client_grant(client_grant_id)
           raise Auth0::InvalidParameter, 'Must specify a client grant id' if client_grant_id.to_s.empty?
           path = "#{client_grants_path}/#{client_grant_id}"
@@ -35,7 +44,7 @@ module Auth0
 
         # Updates a client grant.
         # @see https://auth0.com/docs/api/management/v2#!/client_grants/patch_client_grants_by_id
-        # @param client_id [string] The id of the client grant to update.
+        # @param client_grant_id [string] The id of the client grant to update.
         # @param options [hash] The Hash options used to define the client grant's properties.
         def patch_client_grant(client_grant_id, options)
           raise Auth0::InvalidParameter, 'Must specify a client grant id' if client_grant_id.to_s.empty?

data/lib/auth0/api/v2/clients.rb

@@ -6,16 +6,19 @@ module Auth0
         attr_reader :clients_path
 
         # Retrieves a list of all client applications. Accepts a list of fields to include or exclude.
-        # @see https://auth0.com/docs/api/v2#!/clients/get_clients
-        # @param fields [string] A comma separated list of fields to include or exclude from the result.
+        # @see https://auth0.com/docs/api/management/v2#!/Clients/get_clients
+        # @param fields [string|Array] A comma separated list or an array of fields.
         # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
-        #
+        # @param page [int] Page number to get, 0-based.
+        # @param per_page [int] Results per page if also passing a page number.
         # @return [json] Returns the clients applications.
-        def clients(fields: nil, include_fields: nil)
+        def clients(fields: nil, include_fields: nil, page: nil, per_page: nil)
           include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
-            fields: fields,
-            include_fields: include_fields
+            fields: fields.is_a?(Array) ? fields.join(',') : fields,
+            include_fields: include_fields,
+            page: !page.nil? ? page.to_i : nil,
+            per_page: !page.nil? && !per_page.nil? ? per_page.to_i : nil
           }
           get(clients_path, request_params)
         end

data/lib/auth0/api/v2/connections.rb

@@ -7,18 +7,30 @@ module Auth0
 
         # Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is
         # being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
-        # @see https://auth0.com/docs/api/v2#!/Connections/get_connections
-        # @param strategy [string] Provide a type of strategy to only retrieve connections with that strategy (e.g. 'ad',
-        # 'facebook', 'twitter').
+        # @see https://auth0.com/docs/api/management/v2#!/Connections/get_connections
+        # @param strategy [string] Strategy to filter connection results.
+        # @param name [string] Name to filter connection results.
         # @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.
-        #
+        # @param page [int] Page number to get, 0-based.
+        # @param per_page [int] Results per page if also passing a page number.
         # @return [json] Returns the existing connections matching the strategy.
-        def connections(strategy: nil, fields: nil, include_fields: true)
+        def connections(
+          strategy: nil,
+          name: nil,
+          fields: nil,
+          include_fields: nil,
+          page: nil,
+          per_page: nil
+        )
+          include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
             strategy: strategy,
-            fields: fields,
-            include_fields: include_fields
+            name: name,
+            fields: fields.is_a?(Array) ? fields.join(',') : fields,
+            include_fields: include_fields,
+            page: !page.nil? ? page.to_i : nil,
+            per_page: !page.nil? && !per_page.nil? ? per_page.to_i : nil
           }
           get(connections_path, request_params)
         end

data/lib/auth0/api/v2/device_credentials.rb

@@ -7,11 +7,12 @@ module Auth0
 
         # Retrieves log entries that match the specified search criteria.
         # @see https://auth0.com/docs/api/v2#!/device_credentials/get_device_credentials
-        # @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.
-        # @param user_id [string] The user_id of the devices to retrieve.
         # @param client_id [string] The client_id of the devices to retrieve.
-        # @param type [string] The type of credentials. Possible values: 'public_key' or 'refresh_token'.
+        # @param options [hash]
+        #   * :fields [string] A comma separated list of fields to include or exclude from the result.
+        #   * :include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        #   * :user_id [string] The user_id of the devices to retrieve.
+        #   * :type [string] The type of credentials. Possible values: 'public_key' or 'refresh_token'.
         #
         # @return [json] Returns the list of existing devices for the specified client_id.
         # rubocop:disable Metrics/AbcSize

data/lib/auth0/api/v2/guardian.rb

@@ -0,0 +1,142 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the guardian endpoints
+      module Guardian
+        include Auth0::Mixins::Validation
+
+        # Retrieves a list of Guardian factors.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_factors
+        # @return [json] Returns the list of all Guardian factors.
+        def guardian_factors
+          get(guardian_factors_path)
+        end
+        alias get_guardian_factors guardian_factors
+
+        # Retrieves a single Guardian enrollment.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_enrollments_by_id
+        # @param enrollment_id [string] The enrollment_id of the Guardian enrollment to delete.
+        # @return [json] Returns details of the Guardian enrollment.
+        def guardian_enrollment(enrollment_id)
+          raise Auth0::MissingParameter, 'Must supply a valid enrollment_id' if enrollment_id.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/#{enrollment_id}"
+          get(path)
+        end
+        alias get_guardian_enrollment guardian_enrollment
+
+        # Deletes a single Guardian enrollment given its id.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id
+        # @param enrollment_id [string] The enrollment_id of the Guardian enrollment to delete.
+        def delete_guardian_enrollment(enrollment_id)
+          raise Auth0::MissingParameter, 'Must supply a valid enrollment_id' if enrollment_id.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/#{enrollment_id}"
+          delete(path)
+        end
+
+        # Retrieves SMS enrollment and verification templates.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_templates
+        # @return [json] Returns enrollment and verification templates.
+        def guardian_sms_templates
+          path = "#{guardian_factors_path}/sms/templates"
+          get(path)
+        end
+        alias get_guardian_sms_templates guardian_sms_templates
+
+        # Updates SMS enrollment and verification SMS templates.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_templates
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated SMS enrollment and verification templates.
+        def guardian_update_enrollment_verification_templates(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/sms/templates"
+          put(path, body)
+        end
+
+        # Retrieves provider configuration for AWS SNS.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_sns
+        # @return [json] Returns provider configuration for AWS SNS.
+        def guardian_sns_provider_config
+          path = "#{guardian_factors_path}/push-notification/providers/sns"
+          get(path)
+        end
+        alias get_guardian_sns_provider_config guardian_sns_provider_config
+
+        # Updates provider configuration for AWS SNS.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_sns
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated provider configuration for AWS SNS.
+        def guardian_update_sns_provider_config(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/push-notification/providers/sns"
+          put(path, body)
+        end
+
+        # Retrieves provider configuration for Twilio.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_twilio
+        # @return [json] Returns provider configuration for Twilio.
+        def guardian_twillo_provider_config
+          path = "#{guardian_factors_path}/sms/providers/twilio"
+          get(path)
+        end
+        alias get_guardian_twillo_provider_config guardian_twillo_provider_config
+
+        # Updates provider configuration for Twilio.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated provider configuration for Twilio.
+        def guardian_update_twillo_provider_config(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/sms/providers/twilio"
+          put(path, body)
+        end
+
+        # Creates a Guardian enrollment ticket.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/post_ticket
+        # @param body [hash] User details to create enrollment ticket for.
+        # @return [json] Returns details of created enrollment ticket.
+        def guardian_create_enrollment_ticket(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/ticket"
+          post(path, body)
+        end
+
+        # Updates a Guardian factor.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name
+        # @param name [string] Name of Guardian factor to update.
+        # @param body [hash] The parameters to update.
+        # @return [json] Returns details of updated Guardian factor.
+        def guardian_update_factor(name, body)
+          raise Auth0::MissingParameter, 'Must supply a valid name' if name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/#{name}"
+          put(path, body)
+        end
+
+        private
+
+        # Guardian API path
+        def guardian_path
+          @guardian_path ||= '/api/v2/guardian'
+        end
+
+        def guardian_enrollments_path
+          @guardian_enrollments_path ||= "#{guardian_path}/enrollments"
+        end
+
+        def guardian_factors_path
+          @guardian_factors_path ||= "#{guardian_path}/factors"
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/jobs.rb

@@ -3,47 +3,101 @@ module Auth0
     module V2
       # Methods to use the jobs endpoints
       module Jobs
-        attr_reader :jobs_path
-
         # Retrieves a job. Useful to check its status.
         # @see https://auth0.com/docs/api/v2#!/Jobs/get_jobs_by_job_id
-        # @param job_id [string] The id of the job.
+        # @param job_id [string] The ID of the job.
         #
         # @return [json] Returns the job status and properties.
         def get_job(job_id)
           raise Auth0::InvalidParameter, 'Must specify a job id' if job_id.to_s.empty?
+
           path = "#{jobs_path}/#{job_id}"
           get(path)
         end
 
+        # Retrieve error details based on the id of the job. Useful to check its status.
+        # @see https://auth0.com/docs/api/management/v2#!/Jobs/get_errors
+        # @param job_id [string] The ID of the job.
+        #
+        # @return [json] Returns the job error details.
+        def get_job_errors(job_id)
+          raise Auth0::InvalidParameter, 'Must specify a job id' if job_id.to_s.empty?
+
+          path = "#{jobs_path}/#{job_id}/errors"
+          get(path)
+        end
+
         # Imports users to a connection from a file using a long running job.
-        # Important: The documentation for the file format is at https://docs.auth0.com/bulk-import.
+        # Documentation for the file format: https://docs.auth0.com/bulk-import
         # @see https://auth0.com/docs/api/v2#!/Jobs/post_users_imports
         # @param users_file [file] A file containing the users to import.
-        # @param connection_id [string] The connection id of the connection to which users will be inserted.
-        #
+        # @param connection_id [string] Database connection ID to import to.
+        # @param options [hash]
+        #   * :upsert [boolean] Update the user if already exists. False by default.
+        #   * :external_id [string] Customer defined id
+        #   * :send_completion_email [boolean] If true,
+        #     send the completion email to all tenant owners when the job is finished. True by default.
         # @return [json] Returns the job status and properties.
-        def import_users(users_file, connection_id)
+        def import_users(users_file, connection_id, options = {})
           raise Auth0::InvalidParameter, 'Must specify a valid file' if users_file.to_s.empty?
           raise Auth0::InvalidParameter, 'Must specify a connection_id' if connection_id.to_s.empty?
+
           request_params = {
             users: users_file,
-            connection_id: connection_id
+            connection_id: connection_id,
+            upsert: options.fetch(:upsert, false),
+            external_id: options.fetch(:external_id, nil),
+            send_completion_email: options.fetch(:send_completion_email, true)
           }
           path = "#{jobs_path}/users-imports"
           post_file(path, request_params)
         end
 
+        # Export all users to a file using a long running job.
+        # @see https://auth0.com/docs/api/v2#!/Jobs/post_users_exports
+        # @param options [hash] The options used to configure the output file.
+        #   :connection_id [string] Database connection ID to export from.
+        #   :format [string] The format of the file. Valid values are: "json" and "csv".
+        #   :limit [integer] Limit the number of users to export.
+        #   :fields [array] A list of fields to be included in the CSV.
+        #     If omitted, a set of predefined fields will be exported.
+        #
+        # @return [json] Returns the job status and properties.
+        def export_users(options = {})
+          request_params = {
+            connection_id: options.fetch(:connection_id, nil),
+            format: options.fetch(:format, nil),
+            limit: options.fetch(:limit, nil),
+            fields: fields_for_export(options.fetch(:fields, nil))
+          }
+          path = "#{jobs_path}/users-exports"
+          post(path, request_params)
+        end
+
         # Send an email to the specified user that asks them to click a link to verify their email address.
-        # @see https://auth0.com/docs/api/v2#!/Jobs/post_verification_email
+        # @see https://auth0.com/docs/api/management/v2#!/Jobs/post_verification_email
         # @param user_id [string] The user_id of the user to whom the email will be sent.
+        # @param client_id [string] Client ID to send an Application-specific email.
+        # @param identity [hash] Used to verify secondary, federated, and passwordless-email identities.
+        #   * :user_id [string] user_id of the identity.
+        #   * :provider [string] provider of the identity.
+        # @param organization_id [string] organization id
         #
         # @return [json] Returns the job status and properties.
-        def send_verification_email(user_id)
+        def send_verification_email(user_id, client_id = nil, identity: nil, organization_id: nil)
           raise Auth0::InvalidParameter, 'Must specify a user id' if user_id.to_s.empty?
-          request_params = {
-            user_id: user_id
-          }
+
+          request_params = { user_id: user_id }
+          request_params[:client_id] = client_id unless client_id.nil?
+          request_params[:organization_id] = organization_id unless organization_id.nil?
+
+          if identity
+            unless identity.is_a? Hash
+              raise Auth0::InvalidParameter, 'Identity must be a hash send an email verification'
+            end
+            request_params[:identity] = identity
+          end
+
           path = "#{jobs_path}/verification-email"
           post(path, request_params)
         end
@@ -54,6 +108,16 @@ module Auth0
         def jobs_path
           @jobs_path ||= '/api/v2/jobs'
         end
+
+        # Map array of field names for export to array of objects
+        # @param fields [array] Field names to be included in the export
+
+        # @return [array] Returns the fields mapped as array of objects for the export_users endpoint
+        def fields_for_export(fields)
+          return nil if fields.to_s.empty?
+
+          fields.map { |field| { name: field } }
+        end
       end
     end
   end

data/lib/auth0/api/v2/log_streams.rb

@@ -0,0 +1,78 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the log streams endpoints
+      module LogStreams
+        attr_reader :log_streams_path
+
+        # Retrieves a list of all log streams.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams
+        # @return [json] Returns the log streams.
+        def log_streams()
+          get(log_streams_path)
+        end
+        alias get_log_streams log_streams
+
+        # Retrieves a log stream by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams_by_id
+        # @param id [string] The id of the log stream to retrieve.
+        #
+        # @return [json] Returns the log stream.
+        def log_stream(id)
+          raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty?
+          path = "#{log_streams_path}/#{id}"
+          get(path)
+        end
+        alias get_log_stream log_stream
+
+        # Creates a new log stream according to the JSON object received in body.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/post_log_streams
+        # @param name [string] The name of the log stream.
+        # @param type [string] The type of log stream
+        # @param options [hash] The Hash options used to define the log streams's properties.
+        #
+        # @return [json] Returns the log stream.
+        def create_log_stream(name, type, options)
+          raise Auth0::InvalidParameter, 'Name must contain at least one character' if name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid type' if type.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid hash for options' unless options.is_a? Hash
+
+          request_params = {}
+          request_params[:name] = name
+          request_params[:type] = type
+          request_params[:sink] = options
+          post(log_streams_path, request_params)
+        end
+
+        # Deletes a log stream by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/delete_log_streams_by_id
+        # @param id [string] The id of the log stream to delete.
+        def delete_log_stream(id)
+          raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty?
+          path = "#{log_streams_path}/#{id}"
+          delete(path)
+        end
+
+        # Updates a log stream.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/patch_log_streams_by_id
+        # @param id [string] The id or audience of the log stream to update.
+        # @param status [string] The Hash options used to define the log streams's properties.
+        def patch_log_stream(id, status)
+          raise Auth0::InvalidParameter, 'Must specify a log stream id' if id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid status' if status.to_s.empty?
+
+          request_params = {}
+          request_params[:status] = status
+          path = "#{log_streams_path}/#{id}"
+          patch(path, request_params)
+        end
+        
+        private
+        # Log Streams API path
+        def log_streams_path
+          @log_streams_path ||= '/api/v2/log-streams'
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/logs.rb

@@ -8,16 +8,16 @@ module Auth0
 
         # Retrieves log entries that match the specified search criteria.
         # @see https://auth0.com/docs/api/v2#!/Logs/get_logs
-        # @param q [string] Query in Lucene query string syntax.
-        # @param page [integer] The page number. Zero based.
-        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
-        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
-        # @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.
-        # @param include_totals [string] True if a query summary must be included in the result, false otherwise.
-        # @param from [string] Log Event Id to start retrieving logs. You can limit the amount of logs using the take
-        # parameter.
-        # @param take [integer] The total amount of entries to retrieve when using the from parameter.
+        # @param options [hash]
+        #   * :q [string] Query in Lucene query string syntax.
+        #   * :page [integer] The page number. Zero based.
+        #   * :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        #   * :sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
+        #   * :fields [string] A comma separated list of fields to include or exclude from the result.
+        #   * :include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        #   * :include_totals [string] True if a query summary must be included in the result, false otherwise.
+        #   * :from [string] Log Event Id to start retrieving logs. You can limit the amount of logs using the take parameter.
+        #   * :take [integer] The total amount of entries to retrieve when using the from parameter.
         # Default: 50. Max value: 100.
         #
         # @return [json] Returns the list of existing log entries.
@@ -45,7 +45,7 @@ module Auth0
 
         # Retrieves log entries that match the specified search criteria.
         # @see https://auth0.com/docs/api/v2#!/Logs/get_logs_by_id
-        # @param id [string] The log_id of the log to retrieve.
+        # @param log_id [string] The log_id of the log to retrieve.
         #
         # @return [json] Returns the log with the given id if exists.
         def log(log_id)