auth0 4.16.0 → 5.1.0

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

@@ -9,6 +9,7 @@ module Auth0
         # being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
         # @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.
@@ -16,6 +17,7 @@ module Auth0
         # @return [json] Returns the existing connections matching the strategy.
         def connections(
           strategy: nil,
+          name: nil,
           fields: nil,
           include_fields: nil,
           page: nil,
@@ -24,6 +26,7 @@ module Auth0
           include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
             strategy: strategy,
+            name: name,
             fields: fields.is_a?(Array) ? fields.join(',') : fields,
             include_fields: include_fields,
             page: !page.nil? ? page.to_i : nil,

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

@@ -81,13 +81,15 @@ module Auth0
         # @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, client_id = nil, identity: nil)
+        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[: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

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

@@ -0,0 +1,332 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the organizations endpoints
+      module Organizations
+        include Auth0::Mixins::Validation
+
+        attr_reader :organizations_path
+
+        # Get all organizations.
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations
+        # @param options [hash] The Hash options used to define the paging of rersults
+        #   * :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        #   * :page [integer] The page number. Zero based.
+        #   * :include_totals [boolean] True to include query summary in the result, false or nil otherwise.
+        # @return [json] All Organizations
+        def organizations(options = {})
+          request_params = {
+            per_page:       options.fetch(:per_page, nil),
+            page:           options.fetch(:page, nil),
+            include_totals: options.fetch(:include_totals, nil)
+          }
+          get(organizations_path, request_params)
+        end
+        alias get_organizations organizations
+
+        # Create a new organization.
+        # @see ttps://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations
+        # @param options [hash] See https://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations for available options
+        # @return [json] Returns the created organization.
+        def create_organization(options = {})
+          post(organizations_path, options)
+        end
+
+        # Get an organization by id. A token with read:organizations scope is required
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations_by_id
+        # @param organization_id [string] The organization_id of the user to retrieve.
+        #
+        # @return [json] Returns the organization with the given organization_id if it exists.
+        def organization(organization_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_path}/#{organization_id}"
+          get(path)
+        end
+
+        # Get an organization by name. A token with read:organizations scope is required.
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_name_by_name
+        # @param organization_name [string] The Organization name
+        #
+        # @return [json] Returns the organization with the given organization_name if it exists.
+        def organization_by_name(organization_name)
+          raise Auth0::InvalidParameter, 'Must supply a valid organization_name' if organization_name.to_s.empty?
+          path = "#{organizations_path}/name/#{organization_name}"
+          get(path)
+        end
+
+
+        # Deletes a single organization given its id
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organizations_by_id
+        # @param organization_id [string] The Organization ID
+        def delete_organization(organization_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_path}/#{organization_id}"
+          delete(path)
+        end
+
+        # Update an existing organization.
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/patch_organizations_by_id
+        # @param organization_id [string] The Organization ID
+        # @param body [hash] The optional parameters to update.
+        #
+        # @return [json] Returns the updated user.
+        def patch_organization(organization_id, body)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty? || body.empty?
+          path = "#{organizations_path}/#{organization_id}"
+          patch(path, body)
+        end
+        alias update_organization patch_organization
+
+        ### Organization Enabled Connections
+
+        # Get enabled connections in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections
+        # @param organization_id [string] The Organization ID
+        #
+        # @return [json] Returns the enabled connections for the given organization
+        def get_organizations_enabled_connections(organization_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_enabled_connections_path(organization_id)}"
+          get(path)
+        end
+
+        # Get enabled connection by id in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections_by_connectionId
+        # @param organization_id [string] The Organization ID
+        # @param connection_id [string] The Connection id
+        #
+        # @return [json] Returns the connection for the given organization
+        def get_organizations_enabled_connection(organization_id, connection_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          path = "#{organizations_enabled_connections_path(organization_id)}/#{connection_id}"
+          get(path)
+        end
+
+        # Update an eanbled connection in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/patch_enabled_connections_by_connectionId
+        # @param organization_id [string] The Organization ID
+        # @param connection_id [string] The Connection id
+        # @param assign_membership_on_login [boolean] flag to allow assign membership on login
+        #
+        # @return [json] Returns the connection for the given organization
+        def patch_organizations_enabled_connection(organization_id, connection_id, assign_membership_on_login: nil)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid assign_membership_on_login value' if assign_membership_on_login.nil?
+          path = "#{organizations_enabled_connections_path(organization_id)}/#{connection_id}"
+
+          body = {}
+          body[:assign_membership_on_login] = assign_membership_on_login
+
+          patch(path, body)
+        end
+        alias update_organizations_enabled_connection patch_organizations_enabled_connection
+
+        # Add an enabled connection for an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/post_enabled_connections
+        # @param organization_id [string] The Organization ID
+        # @param assign_membership_on_login [boolean] flag to allow assign membership on login
+        #
+        # @return [json] Returns the connection for the given organization
+        def create_organizations_enabled_connection(organization_id, assign_membership_on_login: false)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_enabled_connections_path(organization_id)}"
+          
+          body = {}
+          body[:assign_membership_on_login] = assign_membership_on_login
+
+          post(path, body)
+        end
+        alias add_organizations_enabled_connection create_organizations_enabled_connection
+
+        # Remove an enabled connection from an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/delete_enabled_connections_by_connectionId
+        # @param organization_id [string] The Organization ID
+        # @param connection_id [string] The Connection id
+        def delete_organizations_enabled_connection(organization_id, connection_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          path = "#{organizations_enabled_connections_path(organization_id)}/#{connection_id}"
+          delete(path)
+        end
+        alias remove_organizations_enabled_connection delete_organizations_enabled_connection
+
+        ### Organization Invites
+
+        # Get invites in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations
+        # @param organization_id [string] The Organization ID
+        #
+        # @return [json] Returns the invites for the given organization
+        def get_organizations_invites(organization_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_invitations_path(organization_id)}"
+          get(path)
+        end
+
+        # Get invite by id in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations_by_invitation_id
+        # @param organization_id [string] The Organization ID
+        # @param invitation_id [string] The invitation id
+        #
+        # @return [json] Returns the invitation for the given organization
+        def get_organizations_invite(organization_id, invitation_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid invitation id' if invitation_id.to_s.empty?
+          path = "#{organizations_invitations_path(organization_id)}/#{invitation_id}"
+          get(path)
+        end
+
+        # Create an invitation in an organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/post_invitations
+        # @param organization_id [string] The Organization ID
+        # @param options [hash] See https://auth0.com/docs/api/management/v2/#!/Organizations/post_invitations
+        # @return [json] Returns the invitation for the given organization
+        def create_organizations_invite(organization_id, options = {})
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_invitations_path(organization_id)}"
+          
+          post(path, options)
+        end
+        alias add_organizations_invite create_organizations_invite
+
+        # Delete an invitation to organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/delete_invitations_by_invitation_id
+        # @param organization_id [string] The Organization ID
+        # @param invitation_id [string] The Invitation id
+        def delete_organizations_invite(organization_id, invitation_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid invitation id' if invitation_id.to_s.empty?
+          path = "#{organizations_invitations_path(organization_id)}/#{invitation_id}"
+          delete(path)
+        end
+        alias remove_organizations_invite delete_organizations_invite
+
+        ### Organization Member
+
+        # Get Members in a Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_members
+        # @param organization_id [string] The Organization ID
+        # @param user_id [string] The User ID
+        #
+        # @return [json] Returns the members for the given organization
+        def get_organizations_members(organization_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          path = "#{organizations_members_path(organization_id)}"
+          get(path)
+        end
+
+        # Add members in an organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/post_members
+        # @param organization_id [string] The Organization ID
+        # @param members [array] Array of user IDs.
+        #
+        # @return [json] Returns the invitation for the given organization
+        def create_organizations_members(organization_id, members = [])
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply an array of member ids' if members.empty?
+          path = "#{organizations_members_path(organization_id)}"
+          
+          body = {}
+          body[:members] = members
+
+          post(path, body)
+        end
+        alias add_organizations_members create_organizations_members
+
+        # Remove members from an organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members
+        # @param organization_id [string] The Organization ID
+        # @param members [array] Array of user IDs.
+        def delete_organizations_members(organization_id, members = [])
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply an array of member ids' if members.empty?
+          path = "#{organizations_members_path(organization_id)}"
+
+          body = {}
+          body[:members] = members
+
+          delete(path, body)
+        end
+        alias remove_organizations_members delete_organizations_members
+
+        ### Organization Member Roles
+
+        # Get Roles assigned to a Member in an Organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_organization_member_roles
+        # @param organization_id [string] The Organization ID
+        # @param user_id [string] The User ID
+        #
+        # @return [json] Returns the member_roles for the given organization
+        def get_organizations_member_roles(organization_id, user_id)
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid user id' if user_id.to_s.empty?
+          path = "#{organizations_member_roles_path(organization_id, user_id)}"
+          get(path)
+        end
+
+        # Assign roles to a member in an organization
+        # @see https://auth0.com/docs/api/management/v2/#!/Organizations/post_organization_member_roles
+        # @param organization_id [string] The Organization ID
+        # @param user_id [string] The User ID
+        # @param roles [array] Array of role IDs.
+        #
+        # @return [json] Returns the invitation for the given organization
+        def create_organizations_member_roles(organization_id, user_id, roles = [])
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid user id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply an array of role ids' if roles.empty?
+          path = "#{organizations_member_roles_path(organization_id, user_id)}"
+          
+          body = {}
+          body[:roles] = roles
+
+          post(path, body)
+        end
+        alias add_organizations_member_roles create_organizations_member_roles
+
+        # Remove roles from a Member of an organization
+        # @https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organization_member_roles
+        # @param organization_id [string] The Organization ID
+        # @param user_id [string] The User ID
+        # @param roles [array] Array of role IDs.
+        def delete_organizations_member_roles(organization_id, user_id, roles = [])
+          raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid user id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply an array of role ids' if roles.empty?
+          path = "#{organizations_member_roles_path(organization_id, user_id)}"
+                    
+          body = {}
+          body[:roles] = roles
+
+          delete(path, body)
+        end
+        alias remove_organizations_member_roles delete_organizations_member_roles
+
+        private
+        # Organizations API path
+        def organizations_path
+          @organizations_path ||= '/api/v2/organizations'
+        end
+
+        def organizations_enabled_connections_path(org_id)
+          "#{organizations_path}/#{org_id}/enabled_connections"
+        end
+
+        def organizations_members_path(org_id)
+          "#{organizations_path}/#{org_id}/members"
+        end
+
+        def organizations_member_roles_path(org_id, user_id)
+          "#{organizations_path}/#{org_id}/members/#{user_id}/roles"
+        end
+
+        def organizations_invitations_path(org_id)
+          "#{organizations_path}/#{org_id}/invitations"
+        end
+      end
+    end
+  end
+end

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

@@ -15,9 +15,11 @@ module Auth0
         # @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 client_id [string] client id
+        # @param organization_id [string] organization id
         #
         # @return [json] Returns the created ticket url.
-        def post_email_verification(user_id, result_url: nil, ttl_sec: nil, identity: nil)
+        def post_email_verification(user_id, result_url: nil, ttl_sec: nil, identity: nil, client_id: nil, organization_id: nil)
           if user_id.to_s.empty?
             raise Auth0::InvalidParameter, 'Must supply a valid user id to post an email verification'
           end
@@ -27,6 +29,8 @@ module Auth0
             result_url: result_url,
             ttl_sec: ttl_sec.is_a?(Integer) ? ttl_sec : nil
           }
+          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
@@ -53,6 +57,8 @@ module Auth0
         # @param includeEmailInRedirect [boolean] Whether or not we include the email as part of the returnUrl
         # in the reset_email
         # @param new_password [string] The password to be set for the user once the ticket is used.
+        # @param client_id [string] client id
+        # @param organization_id [string] organization id
         #
         # @return [json] Returns the created ticket url.
         def post_password_change(
@@ -63,7 +69,10 @@ module Auth0
             ttl_sec: nil,
             mark_email_as_verified: nil,
             includeEmailInRedirect: nil,
-            new_password: nil)
+            new_password: nil,
+            client_id: nil,
+            organization_id: nil
+          )
 
           booleans = [true, false]
           path = "#{tickets_path}/password-change"
@@ -77,6 +86,9 @@ module Auth0
             includeEmailInRedirect: booleans.include?(includeEmailInRedirect) ? includeEmailInRedirect : nil,
             new_password: new_password
           }
+          request_params[:client_id] = client_id unless client_id.nil?
+          request_params[:organization_id] = organization_id unless organization_id.nil?
+
           post(path, request_params)
         end
 

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

@@ -43,13 +43,15 @@ module Auth0
         # The attribute connection is always mandatory but depending on the type of connection you are using there
         # could be others too. For instance, Auth0 DB Connections require email and password.
         # @see https://auth0.com/docs/api/v2#!/Users/post_users
-        # @param name [string] The user name.
-        # @param options [hash]
-        #   * :connection [string] The connection the user belongs to.
+        # @param connection [string]  The connection the user belongs to.
+        # @param options [hash] See https://auth0.com/docs/api/management/v2#!/Users/post_users for available options
         # @return [json] Returns the created user.
-        def create_user(name, options = {})
+        def create_user(connection, options = {})
+          if !connection.is_a?(String) || connection.empty?
+            raise Auth0::MissingParameter, 'Must supply a valid connection'
+          end
           request_params = Hash[options.map { |(k, v)| [k.to_sym, v] }]
-          request_params[:name] = name
+          request_params[:connection] = connection
           post(users_path, request_params)
         end
 
@@ -248,11 +250,22 @@ module Auth0
         # @see https://auth0.com/docs/api/management/v2#!/Users/get_permissions
         #
         # @param user_id [string] The user_id of the permissions to get.
+        # @param options [hash] A hash of options for getting permissions
+        #   * :per_page [integer] The amount of permissions per page. (optional)
+        #   * :page [integer]  The page number. Zero based. (optional)
+        #   * :include_totals [boolean] True if a query summary must be included in the result. (optional)
         #
         # @return [json] Returns permissions for the given user_id.
-        def get_user_permissions(user_id)
+        def get_user_permissions(user_id, options = {})
           raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          get "#{users_path}/#{user_id}/permissions"
+
+          request_params = {
+            per_page: options.fetch(:per_page, nil),
+            page: options.fetch(:page, nil),
+            include_totals: options.fetch(:include_totals, nil)
+          }
+
+          get "#{users_path}/#{user_id}/permissions", request_params
         end
 
         # Remove one or more permissions from a specific user.
@@ -283,7 +296,7 @@ module Auth0
         # @param user_id [string] The user_id of the recovery codes to regenerate.
         def generate_recovery_code(user_id)
           raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          post "#{users_path}/#{user_id}/recovery-code-generation"
+          post "#{users_path}/#{user_id}/recovery-code-regeneration"
         end
 
         # Invalidate all remembered browsers for all authentication factors for a specific user.
@@ -295,6 +308,18 @@ module Auth0
           post "#{users_path}/#{user_id}/multifactor/actions/invalidate-remember-browser"
         end
 
+
+        # Get a list of organizations for a user.
+        #
+        # @param user_id [string] The user_id of the permissions to get.
+        #
+        # @return [json] Returns organizations for the given user_id.
+        def get_user_organizations(user_id)
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+
+          get "#{users_path}/#{user_id}/organizations"
+        end
+
         private
 
         # Users API path