stytch 9.8.0 → 9.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e075ae0bbd1a3f639927bcd53fc125ce81856a38ca08af4fda63a5a67c59a8d2
-  data.tar.gz: f820f820eff94a0d24e504bc1cb2a31d449124609b37edb60d1f6678acfe19e8
+  metadata.gz: 4023ae6cace52f9372e689380961ea0720c243425f8ed54b17f56dd24cb5395a
+  data.tar.gz: 0bd37c0c1b7d57c50ea7150aee027b88dbc59bab2ceafc4b43253b8d7db837d9
 SHA512:
-  metadata.gz: 392f3723a7fd0e3950a4179da49c49dc2c01d469b6b2c4107c6d6d20b9beabcee3b5741c16f260ad04dc440c42122bd3098e5eb91844133c9cf08a4e30f58443
-  data.tar.gz: bb1e40d2bbc571b03215aa94dc40164816fd5559f412c14cb4b9b6b73ef1046a3339005d456ccb294b712d353c17eb53cf08b0fb0bfa030dd061fd11afc92712
+  metadata.gz: 962257a3f4012c7ff59140a8d9adb0b0bdff54a3038b9cf5e9410ec24bfc3361daae2cf0100f21cf3c7b4c7f9bf4ac312082fda641a4f089a2931e75beea8677
+  data.tar.gz: d2f9fb55899bb104dcd12e34b1c662362490d2c2175607b61ed7a5505051b844df61aaea422bd7fbb5e4ca2aa43b3e436056ab8f4d0affa16016de81ec88a105

data/lib/stytch/b2b_discovery.rb

@@ -163,12 +163,6 @@ module StytchB2B
       # intermediate_session_token::
       #   The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
       #   The type of this field is +String+.
-      # organization_name::
-      #   The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain.
-      #   The type of this field is +String+.
-      # organization_slug::
-      #   The unique URL slug of the Organization. A minimum of two characters is required. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. If the slug is not specified, a default slug will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization slug will be generated based on the name portion of the email. Otherwise, the organization slug will be generated based on the email domain.
-      #   The type of this field is +String+.
       # session_duration_minutes::
       #   Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,
       #   returning both an opaque `session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of
@@ -187,6 +181,12 @@ module StytchB2B
       #   delete a key, supply a null value. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored.
       #   Total custom claims size cannot exceed four kilobytes.
       #   The type of this field is nilable +object+.
+      # organization_name::
+      #   The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain.
+      #   The type of this field is nilable +String+.
+      # organization_slug::
+      #   The unique URL slug of the Organization. A minimum of two characters is required. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. If the slug is not specified, a default slug will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization slug will be generated based on the name portion of the email. Otherwise, the organization slug will be generated based on the email domain.
+      #   The type of this field is nilable +String+.
       # organization_logo_url::
       #   The image URL of the Organization logo.
       #   The type of this field is nilable +String+.
@@ -276,7 +276,7 @@ module StytchB2B
       #
       #   The type of this field is nilable +String+.
       # allowed_oauth_tenants::
-      #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack" and "hubspot".
+      #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack", "hubspot", and "github".
       #   The type of this field is nilable +object+.
       #
       # == Returns:
@@ -319,10 +319,10 @@ module StytchB2B
       #   The type of this field is nilable +PrimaryRequired+ (+object+).
       def create(
         intermediate_session_token:,
-        organization_name:,
-        organization_slug:,
         session_duration_minutes: nil,
         session_custom_claims: nil,
+        organization_name: nil,
+        organization_slug: nil,
         organization_logo_url: nil,
         trusted_metadata: nil,
         sso_jit_provisioning: nil,
@@ -340,12 +340,12 @@ module StytchB2B
       )
         headers = {}
         request = {
-          intermediate_session_token: intermediate_session_token,
-          organization_name: organization_name,
-          organization_slug: organization_slug
+          intermediate_session_token: intermediate_session_token
         }
         request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
         request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+        request[:organization_name] = organization_name unless organization_name.nil?
+        request[:organization_slug] = organization_slug unless organization_slug.nil?
         request[:organization_logo_url] = organization_logo_url unless organization_logo_url.nil?
         request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
         request[:sso_jit_provisioning] = sso_jit_provisioning unless sso_jit_provisioning.nil?

data/lib/stytch/b2b_oauth.rb

@@ -165,7 +165,8 @@ module StytchB2B
         @connection = connection
       end
 
-      # Authenticates the Discovery token and exchanges it for an Intermediate Session Token. Intermediate Session Tokens can be used for various Discovery login flows and are valid for 10 minutes.
+      # Authenticates the Discovery token and exchanges it for an Intermediate
+      # Session Token. Intermediate Session Tokens can be used for various Discovery login flows and are valid for 10 minutes.
       #
       # == Parameters:
       # discovery_oauth_token::
@@ -213,11 +214,14 @@ module StytchB2B
       #       c) The Organization has at least one other Member with a verified email address with the same domain as the end user (to prevent phishing attacks).
       #   The type of this field is list of +DiscoveredOrganization+ (+object+).
       # provider_type::
-      #   (no documentation yet)
+      #   Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
       #   The type of this field is +String+.
       # provider_tenant_id::
-      #   (no documentation yet)
+      #   The tenant ID returned by the OAuth provider. This is typically used to identify an organization or group within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the Workspace ID, and in GitHub this is an organization ID. This field will only be populated if exactly one tenant ID is returned from a successful OAuth authentication and developers should prefer `provider_tenant_ids` over this since it accounts for the possibility of an OAuth provider yielding multiple tenant IDs.
       #   The type of this field is +String+.
+      # provider_tenant_ids::
+      #   All tenant IDs returned by the OAuth provider. These is typically used to identify organizations or groups within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the Workspace ID, and in GitHub this is an organization ID. Some OAuth providers do not return tenant IDs, some providers are guaranteed to return one, and some may return multiple. This field will always be populated if at least one tenant ID was returned from the OAuth provider and developers should prefer this field over `provider_tenant_id`.
+      #   The type of this field is list of +String+.
       # status_code::
       #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
       #   The type of this field is +Integer+.

data/lib/stytch/b2b_organizations.rb

@@ -159,7 +159,7 @@ module StytchB2B
     #
     #   The type of this field is nilable +String+.
     # allowed_oauth_tenants::
-    #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack" and "hubspot".
+    #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack", "hubspot", and "github".
     #   The type of this field is nilable +object+.
     #
     # == Returns:
@@ -385,7 +385,7 @@ module StytchB2B
     # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.oauth-tenant-jit-provisioning` action on the `stytch.organization` Resource.
     #   The type of this field is nilable +String+.
     # allowed_oauth_tenants::
-    #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack" and "hubspot".
+    #   A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack", "hubspot", and "github".
     #
     # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.allowed-oauth-tenants` action on the `stytch.organization` Resource.
     #   The type of this field is nilable +object+.
@@ -1137,6 +1137,32 @@ module StytchB2B
         get_request(request, headers)
       end
 
+      # Retrieve the saved OIDC access tokens and ID tokens for a member. After a successful OIDC login, Stytch will save the
+      # issued access token and ID token from the identity provider. If a refresh token has been issued, Stytch will refresh the
+      # access token automatically.
+      #
+      # == Parameters:
+      # organization_id::
+      #   Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
+      #   The type of this field is +String+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+      #   The type of this field is +String+.
+      # include_refresh_token::
+      #   Whether to return the refresh token Stytch has stored for the OAuth Provider. Defaults to false. **Important:** If your application exchanges the refresh token, Stytch may not be able to automatically refresh access tokens in the future.
+      #   The type of this field is nilable +Boolean+.
+      #
+      # == Returns:
+      # An object with the following fields:
+      # request_id::
+      #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+      #   The type of this field is +String+.
+      # registrations::
+      #   A list of tokens the member is registered with.
+      #   The type of this field is list of +OIDCProviderInfo+ (+object+).
+      # status_code::
+      #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+      #   The type of this field is +Integer+.
       def oidc_providers(
         organization_id:,
         member_id:,
@@ -1475,6 +1501,125 @@ module StytchB2B
           request = request_with_query_params("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/oauth_providers/microsoft", query_params)
           get_request(request, headers)
         end
+
+        # Retrieve the saved Slack access token and ID token for a member. After a successful OAuth login, Stytch will save the
+        # issued access token and ID token from the identity provider.
+        #
+        # == Parameters:
+        # organization_id::
+        #   Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        # member_id::
+        #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        #
+        # == Returns:
+        # An object with the following fields:
+        # request_id::
+        #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+        #   The type of this field is +String+.
+        # provider_type::
+        #   Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
+        #   The type of this field is +String+.
+        # registrations::
+        #   A list of tokens the member is registered with.
+        #   The type of this field is list of +SlackProviderInfo+ (+object+).
+        # status_code::
+        #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+        #   The type of this field is +Integer+.
+        def slack(
+          organization_id:,
+          member_id:
+        )
+          headers = {}
+          query_params = {}
+          request = request_with_query_params("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/oauth_providers/slack", query_params)
+          get_request(request, headers)
+        end
+
+        # Retrieve the saved Hubspot access token and ID token for a member. After a successful OAuth login, Stytch will save the
+        # issued access token and ID token from the identity provider. If a refresh token has been issued, Stytch will refresh the
+        # access token automatically.
+        #
+        # == Parameters:
+        # organization_id::
+        #   Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        # member_id::
+        #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        # include_refresh_token::
+        #   Whether to return the refresh token Stytch has stored for the OAuth Provider. Defaults to false. **Important:** If your application exchanges the refresh token, Stytch may not be able to automatically refresh access tokens in the future.
+        #   The type of this field is nilable +Boolean+.
+        #
+        # == Returns:
+        # An object with the following fields:
+        # request_id::
+        #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+        #   The type of this field is +String+.
+        # provider_type::
+        #   Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
+        #   The type of this field is +String+.
+        # registrations::
+        #   A list of tokens the member is registered with.
+        #   The type of this field is list of +HubspotProviderInfo+ (+object+).
+        # status_code::
+        #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+        #   The type of this field is +Integer+.
+        def hubspot(
+          organization_id:,
+          member_id:,
+          include_refresh_token: nil
+        )
+          headers = {}
+          query_params = {
+            include_refresh_token: include_refresh_token
+          }
+          request = request_with_query_params("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/oauth_providers/hubspot", query_params)
+          get_request(request, headers)
+        end
+
+        # Retrieve the saved GitHub access token for a Member. After a successful OAuth login, Stytch will save the
+        # issued access token from the identity provider. GitHub does not issue refresh tokens, but will invalidate access
+        # tokens after very long periods of inactivity.
+        #
+        # == Parameters:
+        # organization_id::
+        #   Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        # member_id::
+        #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+        #   The type of this field is +String+.
+        # include_refresh_token::
+        #   Whether to return the refresh token Stytch has stored for the OAuth Provider. Defaults to false. **Important:** If your application exchanges the refresh token, Stytch may not be able to automatically refresh access tokens in the future.
+        #   The type of this field is nilable +Boolean+.
+        #
+        # == Returns:
+        # An object with the following fields:
+        # request_id::
+        #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+        #   The type of this field is +String+.
+        # provider_type::
+        #   Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
+        #   The type of this field is +String+.
+        # registrations::
+        #   A list of tokens the member is registered with.
+        #   The type of this field is list of +GithubProviderInfo+ (+object+).
+        # status_code::
+        #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+        #   The type of this field is +Integer+.
+        def github(
+          organization_id:,
+          member_id:,
+          include_refresh_token: nil
+        )
+          headers = {}
+          query_params = {
+            include_refresh_token: include_refresh_token
+          }
+          request = request_with_query_params("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/oauth_providers/github", query_params)
+          get_request(request, headers)
+        end
       end
     end
   end

data/lib/stytch/b2b_otp.rb

@@ -33,7 +33,7 @@ module StytchB2B
       #
       # An error will be thrown if the Member already has a phone number and the provided `mfa_phone_number` does not match the existing one.
       #
-      # Note that sending another OTP code before the first has expired will invalidate the first code.
+      # OTP codes expire after two minutes. Note that sending another OTP code before the first has expired will invalidate the first code.
       #
       # If a Member has a phone number and is enrolled in MFA, then after a successful primary authentication event (e.g. [email magic link](https://stytch.com/docs/b2b/api/authenticate-magic-link) or [SSO](https://stytch.com/docs/b2b/api/sso-authenticate) login is complete), an SMS OTP will automatically be sent to their phone number. In that case, this endpoint should only be used for subsequent authentication events, such as prompting a Member for an OTP again after a period of inactivity.
       #
@@ -116,7 +116,9 @@ module StytchB2B
 
       # SMS OTPs may not be used as a primary authentication mechanism. They can be used to complete an MFA requirement, or they can be used as a step-up factor to be added to an existing session.
       #
-      # This endpoint verifies that the one-time passcode (OTP) is valid and hasn't expired or been previously used. A given Member may only have a single active OTP code at any given time. If a Member requests another OTP code before the first one has expired, the first one will be invalidated.
+      # This endpoint verifies that the one-time passcode (OTP) is valid and hasn't expired or been previously used. OTP codes expire after two minutes.
+      #
+      # A given Member may only have a single active OTP code at any given time. If a Member requests another OTP code before the first one has expired, the first one will be invalidated.
       #
       # Exactly one of `intermediate_session_token`, `session_token`, or `session_jwt` must be provided in the request.
       # If an intermediate session token is provided, this operation will consume it.

data/lib/stytch/b2b_passwords.rb

@@ -11,7 +11,7 @@ require_relative 'request_helper'
 module StytchB2B
   class Passwords
     include Stytch::RequestHelper
-    attr_reader :email, :sessions, :existing_password
+    attr_reader :email, :sessions, :existing_password, :discovery
 
     def initialize(connection)
       @connection = connection
@@ -19,6 +19,7 @@ module StytchB2B
       @email = StytchB2B::Passwords::Email.new(@connection)
       @sessions = StytchB2B::Passwords::Sessions.new(@connection)
       @existing_password = StytchB2B::Passwords::ExistingPassword.new(@connection)
+      @discovery = StytchB2B::Passwords::Discovery.new(@connection)
     end
 
     # This API allows you to check whether the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.
@@ -327,6 +328,25 @@ module StytchB2B
     end
 
     class Email
+      class RequireResetRequestOptions
+        # Optional authorization object.
+        # Pass in an active Stytch Member session token or session JWT and the request
+        # will be run using that member's permissions.
+        attr_accessor :authorization
+
+        def initialize(
+          authorization: nil
+        )
+          @authorization = authorization
+        end
+
+        def to_headers
+          headers = {}
+          headers.merge!(@authorization.to_headers) if authorization
+          headers
+        end
+      end
+
       include Stytch::RequestHelper
 
       def initialize(connection)
@@ -551,19 +571,51 @@ module StytchB2B
         post_request('/v1/b2b/passwords/email/reset', request, headers)
       end
 
-      def delete(
+      # Require a password be reset by the associated email address. This endpoint is only functional for cross-org password use cases.
+      #
+      # == Parameters:
+      # email_address::
+      #   The email address of the Member to start the email reset process for.
+      #   The type of this field is +String+.
+      # organization_id::
+      #   Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
+      #   The type of this field is nilable +String+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+      #   The type of this field is nilable +String+.
+      #
+      # == Returns:
+      # An object with the following fields:
+      # member::
+      #   The [Member object](https://stytch.com/docs/b2b/api/member-object)
+      #   The type of this field is +Member+ (+object+).
+      # organization::
+      #   The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
+      #   The type of this field is +Organization+ (+object+).
+      # status_code::
+      #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+      #   The type of this field is +Integer+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member.
+      #   The type of this field is nilable +String+.
+      #
+      # == Method Options:
+      # This method supports an optional +StytchB2B::Passwords::Email::RequireResetRequestOptions+ object which will modify the headers sent in the HTTP request.
+      def require_reset(
         email_address:,
         organization_id: nil,
-        member_id: nil
+        member_id: nil,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {
           email_address: email_address
         }
         request[:organization_id] = organization_id unless organization_id.nil?
         request[:member_id] = member_id unless member_id.nil?
 
-        post_request('/v1/b2b/passwords/email/delete', request, headers)
+        post_request('/v1/b2b/passwords/email/require_reset', request, headers)
       end
     end
 
@@ -810,5 +862,199 @@ module StytchB2B
         post_request('/v1/b2b/passwords/existing_password/reset', request, headers)
       end
     end
+
+    class Discovery
+      include Stytch::RequestHelper
+      attr_reader :email
+
+      def initialize(connection)
+        @connection = connection
+
+        @email = StytchB2B::Passwords::Discovery::Email.new(@connection)
+      end
+
+      # Authenticate an email/password combination in the discovery flow. This authenticate flow is only valid for cross-org passwords use cases, and is not tied to a specific organization.
+      #
+      # If you have breach detection during authentication enabled in your [password strength policy](https://stytch.com/docs/b2b/guides/passwords/strength-policies) and the member's credentials have appeared in the HaveIBeenPwned dataset, this endpoint will return a `member_reset_password` error even if the member enters a correct password. We force a password reset in this case to ensure that the member is the legitimate owner of the email address and not a malicious actor abusing the compromised credentials.
+      #
+      # If successful, this endpoint will create a new intermediate session and return a list of discovered organizations that can be session exchanged into.
+      #
+      # == Parameters:
+      # email_address::
+      #   The email address of the Member.
+      #   The type of this field is +String+.
+      # password::
+      #   The password to authenticate, reset, or set for the first time. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characers, etc.
+      #   The type of this field is +String+.
+      #
+      # == Returns:
+      # An object with the following fields:
+      # request_id::
+      #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+      #   The type of this field is +String+.
+      # email_address::
+      #   The email address.
+      #   The type of this field is +String+.
+      # intermediate_session_token::
+      #   The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
+      #   The type of this field is +String+.
+      # discovered_organizations::
+      #   An array of `discovered_organization` objects tied to the `intermediate_session_token`, `session_token`, or `session_jwt`. See the [Discovered Organization Object](https://stytch.com/docs/b2b/api/discovered-organization-object) for complete details.
+      #
+      #   Note that Organizations will only appear here under any of the following conditions:
+      #   1. The end user is already a Member of the Organization.
+      #   2. The end user is invited to the Organization.
+      #   3. The end user can join the Organization because:
+      #
+      #       a) The Organization allows JIT provisioning.
+      #
+      #       b) The Organizations' allowed domains list contains the Member's email domain.
+      #
+      #       c) The Organization has at least one other Member with a verified email address with the same domain as the end user (to prevent phishing attacks).
+      #   The type of this field is list of +DiscoveredOrganization+ (+object+).
+      # status_code::
+      #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+      #   The type of this field is +Integer+.
+      def authenticate(
+        email_address:,
+        password:
+      )
+        headers = {}
+        request = {
+          email_address: email_address,
+          password: password
+        }
+
+        post_request('/v1/b2b/passwords/discovery/authenticate', request, headers)
+      end
+
+      class Email
+        include Stytch::RequestHelper
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        # Initiates a password reset for the email address provided, when cross-org passwords are enabled. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.
+        #
+        # This endpoint adapts to your Project's password strength configuration.
+        # If you're using [zxcvbn](https://stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid
+        # if the strength score is >= 3. If you're using [LUDS](https://stytch.com/docs/guides/passwords/strength-policy), your passwords are
+        # considered valid if they meet the requirements that you've set with Stytch.
+        # You may update your password strength configuration in the [stytch dashboard](https://stytch.com/dashboard/password-strength-config).
+        #
+        # == Parameters:
+        # email_address::
+        #   The email address of the Member to start the email reset process for.
+        #   The type of this field is +String+.
+        # reset_password_redirect_url::
+        #   The URL that the Member clicks from the reset password link. This URL should be an endpoint in the backend server that verifies the request by querying
+        #   Stytch's authenticate endpoint and finishes the reset password flow. If this value is not passed, the default `reset_password_redirect_url` that you set in your Dashboard is used.
+        #   If you have not set a default `reset_password_redirect_url`, an error is returned.
+        #   The type of this field is nilable +String+.
+        # discovery_redirect_url::
+        #   The URL that the end user clicks from the discovery Magic Link. This URL should be an endpoint in the backend server that
+        #   verifies the request by querying Stytch's discovery authenticate endpoint and continues the flow. If this value is not passed, the default
+        #   discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery redirect URL, an error is returned.
+        #   The type of this field is nilable +String+.
+        # reset_password_template_id::
+        #   Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic Links - Reset Password.
+        #   The type of this field is nilable +String+.
+        # reset_password_expiration_minutes::
+        #   Sets a time limit after which the email link to reset the member's password will no longer be valid.
+        #   The type of this field is nilable +Integer+.
+        # pkce_code_challenge::
+        #   (no documentation yet)
+        #   The type of this field is nilable +String+.
+        # locale::
+        #   Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
+        #
+        # Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.
+        #
+        # Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
+        #
+        #   The type of this field is nilable +String+.
+        #
+        # == Returns:
+        # An object with the following fields:
+        # request_id::
+        #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+        #   The type of this field is +String+.
+        # status_code::
+        #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+        #   The type of this field is +Integer+.
+        def reset_start(
+          email_address:,
+          reset_password_redirect_url: nil,
+          discovery_redirect_url: nil,
+          reset_password_template_id: nil,
+          reset_password_expiration_minutes: nil,
+          pkce_code_challenge: nil,
+          locale: nil
+        )
+          headers = {}
+          request = {
+            email_address: email_address
+          }
+          request[:reset_password_redirect_url] = reset_password_redirect_url unless reset_password_redirect_url.nil?
+          request[:discovery_redirect_url] = discovery_redirect_url unless discovery_redirect_url.nil?
+          request[:reset_password_template_id] = reset_password_template_id unless reset_password_template_id.nil?
+          request[:reset_password_expiration_minutes] = reset_password_expiration_minutes unless reset_password_expiration_minutes.nil?
+          request[:pkce_code_challenge] = pkce_code_challenge unless pkce_code_challenge.nil?
+          request[:locale] = locale unless locale.nil?
+
+          post_request('/v1/b2b/passwords/discovery/email/reset/start', request, headers)
+        end
+
+        # Reset the password associated with an email and start an intermediate session. This endpoint checks that the password reset token is valid, hasn’t expired, or already been used.
+        #
+        # The provided password needs to meet the project's password strength requirements, which can be checked in advance with the password strength endpoint. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.
+        #
+        # Resetting a password will start an intermediate session and return a list of discovered organizations the session can be exchanged into.
+        #
+        # == Parameters:
+        # password_reset_token::
+        #   The password reset token to authenticate.
+        #   The type of this field is +String+.
+        # password::
+        #   The password to authenticate, reset, or set for the first time. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characers, etc.
+        #   The type of this field is +String+.
+        # pkce_code_verifier::
+        #   (no documentation yet)
+        #   The type of this field is nilable +String+.
+        #
+        # == Returns:
+        # An object with the following fields:
+        # request_id::
+        #   Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
+        #   The type of this field is +String+.
+        # intermediate_session_token::
+        #   The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
+        #   The type of this field is +String+.
+        # email_address::
+        #   (no documentation yet)
+        #   The type of this field is +String+.
+        # discovered_organizations::
+        #   (no documentation yet)
+        #   The type of this field is list of +DiscoveredOrganization+ (+object+).
+        # status_code::
+        #   The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
+        #   The type of this field is +Integer+.
+        def reset(
+          password_reset_token:,
+          password:,
+          pkce_code_verifier: nil
+        )
+          headers = {}
+          request = {
+            password_reset_token: password_reset_token,
+            password: password
+          }
+          request[:pkce_code_verifier] = pkce_code_verifier unless pkce_code_verifier.nil?
+
+          post_request('/v1/b2b/passwords/discovery/email/reset', request, headers)
+        end
+      end
+    end
   end
 end

data/lib/stytch/b2b_sso.rb

@@ -311,7 +311,9 @@ module StytchB2B
       #   A human-readable display name for the connection.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +CreateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:
@@ -394,7 +396,9 @@ module StytchB2B
       #   The location of the IdP's JSON Web Key Set, used to verify credentials issued by the IdP. This will be provided by the IdP.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +UpdateConnectionRequestIdentityProvider+ (string enum).
       # custom_scopes::
       #   Include a space-separated list of custom scopes that you'd like to include. Note that this list must be URL encoded, e.g. the spaces must be expressed as %20.
@@ -548,7 +552,9 @@ module StytchB2B
       #   A human-readable display name for the connection.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +CreateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:
@@ -617,15 +623,16 @@ module StytchB2B
       #   Defines the names of the SAML groups
       #  that grant specific role assignments. For each group-Role pair, if a Member logs in with this SAML connection and
       #  belongs to the specified SAML group, they will be granted the associated Role. See the
-      #  [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.
-      #          Before adding any group implicit role assignments, you must add a "groups" key to your SAML connection's
+      #  [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment. Before adding any group implicit role assignments, you must add a "groups" key to your SAML connection's
       #          `attribute_mapping`. Make sure that your IdP is configured to correctly send the group information.
       #   The type of this field is nilable list of +SAMLGroupImplicitRoleAssignment+.
       # alternative_audience_uri::
       #   An alternative URL to use for the Audience Restriction. This value can be used when you wish to migrate an existing SAML integration to Stytch with zero downtime. Read our [SSO migration guide](https://stytch.com/docs/b2b/guides/migrations/additional-migration-considerations) for more info.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +UpdateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:
@@ -877,14 +884,13 @@ module StytchB2B
       #   A human-readable display name for the connection.
       #   The type of this field is nilable +String+.
       # external_connection_implicit_role_assignments::
-      #   All Members who log in with this External connection will implicitly receive the specified Roles. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.Implicit role assignments are not supported for External connections if the underlying SSO connection is an OIDC connection.
+      #   All Members who log in with this External connection will implicitly receive the specified Roles. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment. Implicit role assignments are not supported for External connections if the underlying SSO connection is an OIDC connection.
       #   The type of this field is nilable list of +ConnectionImplicitRoleAssignment+.
       # external_group_implicit_role_assignments::
       #   Defines the names of the groups
       #  that grant specific role assignments. For each group-Role pair, if a Member logs in with this external connection and
       #  belongs to the specified group, they will be granted the associated Role. See the
-      #  [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.
-      #          Before adding any group implicit role assignments to an external connection, you must add a "groups" key to the underlying SAML connection's
+      #  [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment. Before adding any group implicit role assignments to an external connection, you must add a "groups" key to the underlying SAML connection's
       #          `attribute_mapping`. Make sure that the SAML connection IdP is configured to correctly send the group information. Implicit role assignments are not supported
       #          for External connections if the underlying SSO connection is an OIDC connection.
       #   The type of this field is nilable list of +GroupImplicitRoleAssignment+.

data/lib/stytch/otps.rb

@@ -485,10 +485,10 @@ module Stytch
       #   The `session_jwt` associated with a User's existing Session.
       #   The type of this field is nilable +String+.
       # login_template_id::
-      #   Use a custom template for login emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic links - Login.
+      #   Use a custom template for login emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - Login.
       #   The type of this field is nilable +String+.
       # signup_template_id::
-      #   Use a custom template for sign-up emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic links - Sign-up.
+      #   Use a custom template for sign-up emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - Sign-up.
       #   The type of this field is nilable +String+.
       #
       # == Returns:

data/lib/stytch/users.rb

@@ -156,7 +156,15 @@ module Stytch
       get_request(request, headers)
     end
 
-    # Search for Users within your Stytch Project. Submit an empty `query` in the request to return all Users.
+    # Search for Users within your Stytch Project.
+    #
+    # Use the `query` object to filter by different fields. See the `query.operands.filter_value` documentation below for a list of available filters.
+    #
+    # ### Export all User data
+    #
+    # Submit an empty `query` in your Search Users request to return all of your Stytch Project's Users.
+    #
+    # [This Github repository](https://github.com/stytchauth/stytch-node-export-users) contains a utility that leverages the Search Users endpoint to export all of your User data to a CSV or JSON file.
     #
     # == Parameters:
     # cursor::

data/lib/stytch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stytch
-  VERSION = '9.8.0'
+  VERSION = '9.10.0'
 end

data/lib/stytch/webauthn.rb

@@ -41,6 +41,15 @@ module Stytch
     #   If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `residentKey` set to `"required"` and `userVerification` set to `"preferred"`.
     #
     #   The type of this field is nilable +Boolean+.
+    # override_id::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
+    # override_name::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
+    # override_display_name::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
     #
     # == Returns:
     # An object with the following fields:
@@ -61,7 +70,10 @@ module Stytch
       domain:,
       user_agent: nil,
       authenticator_type: nil,
-      return_passkey_credential_options: nil
+      return_passkey_credential_options: nil,
+      override_id: nil,
+      override_name: nil,
+      override_display_name: nil
     )
       headers = {}
       request = {
@@ -71,6 +83,9 @@ module Stytch
       request[:user_agent] = user_agent unless user_agent.nil?
       request[:authenticator_type] = authenticator_type unless authenticator_type.nil?
       request[:return_passkey_credential_options] = return_passkey_credential_options unless return_passkey_credential_options.nil?
+      request[:override_id] = override_id unless override_id.nil?
+      request[:override_name] = override_name unless override_name.nil?
+      request[:override_display_name] = override_display_name unless override_display_name.nil?
 
       post_request('/v1/webauthn/register/start', request, headers)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 9.8.0
+  version: 9.10.0
 platform: ruby
 authors:
 - stytch
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,7 +100,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.24.0
-description:
+description: 
 email:
 - support@stytch.com
 executables: []
@@ -162,7 +162,7 @@ licenses:
 metadata:
   homepage_uri: https://stytch.com
   source_code_uri: https://github.com/stytchauth/stytch-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Stytch Ruby Gem
 test_files: []