stytch 6.4.0 → 7.2.0

data/lib/stytch/b2b_totps.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+# !!!
+# WARNING: This file is autogenerated
+# Only modify code within MANUAL() sections
+# or your changes may be overwritten later!
+# !!!
+
+require_relative 'request_helper'
+
+module StytchB2B
+  class TOTPs
+    include Stytch::RequestHelper
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Create a new TOTP instance for a Member. The Member can use the authenticator application of their choice to scan the QR code or enter the secret.
+    #
+    # Passing an intermediate session token, session token, or session JWT is not required, but if passed must match the Member ID passed.
+    #
+    # == 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+.
+    # expiration_minutes::
+    #   The expiration for the TOTP registration. If the newly created TOTP registration is not authenticated within this time frame the member will have to restart the registration flow. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 1440.
+    #   The type of this field is nilable +Integer+.
+    # 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) to complete an MFA flow;
+    #     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 nilable +String+.
+    # session_token::
+    #   A secret token for a given Stytch Session.
+    #   The type of this field is nilable +String+.
+    # session_jwt::
+    #   The JSON Web Token (JWT) for a given Stytch Session.
+    #   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+.
+    # member_id::
+    #   Globally unique UUID that identifies a specific Member.
+    #   The type of this field is +String+.
+    # totp_registration_id::
+    #   The unique ID for a TOTP instance.
+    #   The type of this field is +String+.
+    # secret::
+    #   The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.
+    #   The type of this field is +String+.
+    # qr_code::
+    #   The QR code image encoded in base64.
+    #   The type of this field is +String+.
+    # recovery_codes::
+    #   An array of recovery codes that can be used to recover a Member's account.
+    #   The type of this field is list of +String+.
+    # 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+.
+    def create(
+      organization_id:,
+      member_id:,
+      expiration_minutes: nil,
+      intermediate_session_token: nil,
+      session_token: nil,
+      session_jwt: nil
+    )
+      headers = {}
+      request = {
+        organization_id: organization_id,
+        member_id: member_id
+      }
+      request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
+      request[:intermediate_session_token] = intermediate_session_token unless intermediate_session_token.nil?
+      request[:session_token] = session_token unless session_token.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
+
+      post_request('/v1/b2b/totp', request, headers)
+    end
+
+    # Authenticate a Member provided TOTP.
+    #
+    # == 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+.
+    # code::
+    #   The code to authenticate.
+    #   The type of this field is +String+.
+    # 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) to complete an MFA flow;
+    #     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 nilable +String+.
+    # session_token::
+    #   A secret token for a given Stytch Session.
+    #   The type of this field is nilable +String+.
+    # session_jwt::
+    #   The JSON Web Token (JWT) for a given Stytch Session.
+    #   The type of this field is nilable +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
+    #   five minutes regardless of the underlying session duration, and will need to be refreshed over time.
+    #
+    #   This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).
+    #
+    #   If a `session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.
+    #
+    #   If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration. If you don't want
+    #   to use the Stytch session product, you can ignore the session fields in the response.
+    #   The type of this field is nilable +Integer+.
+    # session_custom_claims::
+    #   Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in
+    #   `session_duration_minutes`. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To
+    #   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+.
+    # set_mfa_enrollment::
+    #   Optionally sets the Member’s MFA enrollment status upon a successful authentication. If the Organization’s MFA policy is `REQUIRED_FOR_ALL`, this field will be ignored. If this field is not passed in, the Member’s `mfa_enrolled` boolean will not be affected. The options are:
+    #
+    #   `enroll` – sets the Member's `mfa_enrolled` boolean to `true`. The Member will be required to complete an MFA step upon subsequent logins to the Organization.
+    #
+    #   `unenroll` –  sets the Member's `mfa_enrolled` boolean to `false`. The Member will no longer be required to complete MFA steps when logging in to the Organization.
+    #
+    #   The type of this field is nilable +String+.
+    # set_default_mfa::
+    #   If passed will set the authenticated method to the default MFA method. Completing an MFA authentication flow for the first time for a Member will implicitly set the method to the default MFA method. This option can be used to update the default MFA method if multiple are being used.
+    #   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+.
+    # member_id::
+    #   Globally unique UUID that identifies a specific Member.
+    #   The type of this field is +String+.
+    # 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+).
+    # session_token::
+    #   A secret token for a given Stytch Session.
+    #   The type of this field is +String+.
+    # session_jwt::
+    #   The JSON Web Token (JWT) for a given Stytch Session.
+    #   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+.
+    # member_session::
+    #   The [Session object](https://stytch.com/docs/b2b/api/session-object).
+    #   The type of this field is nilable +MemberSession+ (+object+).
+    def authenticate(
+      organization_id:,
+      member_id:,
+      code:,
+      intermediate_session_token: nil,
+      session_token: nil,
+      session_jwt: nil,
+      session_duration_minutes: nil,
+      session_custom_claims: nil,
+      set_mfa_enrollment: nil,
+      set_default_mfa: nil
+    )
+      headers = {}
+      request = {
+        organization_id: organization_id,
+        member_id: member_id,
+        code: code
+      }
+      request[:intermediate_session_token] = intermediate_session_token unless intermediate_session_token.nil?
+      request[:session_token] = session_token unless session_token.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
+      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[:set_mfa_enrollment] = set_mfa_enrollment unless set_mfa_enrollment.nil?
+      request[:set_default_mfa] = set_default_mfa unless set_default_mfa.nil?
+
+      post_request('/v1/b2b/totp/authenticate', request, headers)
+    end
+
+    # Migrate an existing TOTP instance for a Member. Recovery codes are not required and will be minted for the Member if not provided.
+    #
+    # == 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+.
+    # secret::
+    #   The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.
+    #   The type of this field is +String+.
+    # recovery_codes::
+    #   An existing set of recovery codes to be imported into Stytch to be used to authenticate in place of the secondary MFA method.
+    #   The type of this field is list of +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+.
+    # member_id::
+    #   Globally unique UUID that identifies a specific Member.
+    #   The type of this field is +String+.
+    # 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+).
+    # totp_registration_id::
+    #   The unique ID for a TOTP instance.
+    #   The type of this field is +String+.
+    # recovery_codes::
+    #   An array of recovery codes that can be used to recover a Member's account.
+    #   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+.
+    def migrate(
+      organization_id:,
+      member_id:,
+      secret:,
+      recovery_codes:
+    )
+      headers = {}
+      request = {
+        organization_id: organization_id,
+        member_id: member_id,
+        secret: secret,
+        recovery_codes: recovery_codes
+      }
+
+      post_request('/v1/b2b/totp/migrate', request, headers)
+    end
+  end
+end

data/lib/stytch/client.rb

@@ -25,12 +25,12 @@ module Stytch
       create_connection(&block)
 
       @crypto_wallets = Stytch::CryptoWallets.new(@connection)
-      @m2m = Stytch::M2M.new(@connection, project_id)
+      @m2m = Stytch::M2M.new(@connection, @project_id)
       @magic_links = Stytch::MagicLinks.new(@connection)
       @oauth = Stytch::OAuth.new(@connection)
       @otps = Stytch::OTPs.new(@connection)
       @passwords = Stytch::Passwords.new(@connection)
-      @sessions = Stytch::Sessions.new(@connection, project_id)
+      @sessions = Stytch::Sessions.new(@connection, @project_id)
       @totps = Stytch::TOTPs.new(@connection)
       @users = Stytch::Users.new(@connection)
       @webauthn = Stytch::WebAuthn.new(@connection)

data/lib/stytch/crypto_wallets.rb

@@ -59,6 +59,7 @@ module Stytch
       session_token: nil,
       session_jwt: nil
     )
+      headers = {}
       request = {
         crypto_wallet_type: crypto_wallet_type,
         crypto_wallet_address: crypto_wallet_address
@@ -67,7 +68,7 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-      post_request('/v1/crypto_wallets/authenticate/start', request)
+      post_request('/v1/crypto_wallets/authenticate/start', request, headers)
     end
 
     # Complete the authentication of a crypto wallet by passing the signature.
@@ -140,6 +141,7 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {
         crypto_wallet_type: crypto_wallet_type,
         crypto_wallet_address: crypto_wallet_address,
@@ -150,7 +152,7 @@ module Stytch
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/crypto_wallets/authenticate', request)
+      post_request('/v1/crypto_wallets/authenticate', request, headers)
     end
   end
 end

data/lib/stytch/errors.rb

@@ -35,4 +35,18 @@ module Stytch
       super(msg)
     end
   end
+
+  class TenancyError < StandardError
+    def initialize(subject_org_id, request_org_id)
+      msg = "Subject organization_id #{subject_org_id} does not match authZ request organization_id #{request_org_id}"
+      super(msg)
+    end
+  end
+
+  class PermissionError < StandardError
+    def initialize(request)
+      msg = "Permission denied for request #{request}"
+      super(msg)
+    end
+  end
 end

data/lib/stytch/m2m.rb

@@ -17,7 +17,6 @@ module Stytch
       @connection = connection
 
       @clients = Stytch::M2M::Clients.new(@connection)
-
       @project_id = project_id
       @cache_last_update = 0
       @jwks_loader = lambda do |options|
@@ -191,9 +190,10 @@ module Stytch
       def get(
         client_id:
       )
+        headers = {}
         query_params = {}
         request = request_with_query_params("/v1/m2m/clients/#{client_id}", query_params)
-        get_request(request)
+        get_request(request, headers)
       end
 
       # Search for M2M Clients within your Stytch Project. Submit an empty `query` in the request to return all M2M Clients.
@@ -233,12 +233,13 @@ module Stytch
         limit: nil,
         query: nil
       )
+        headers = {}
         request = {}
         request[:cursor] = cursor unless cursor.nil?
         request[:limit] = limit unless limit.nil?
         request[:query] = query unless query.nil?
 
-        post_request('/v1/m2m/clients/search', request)
+        post_request('/v1/m2m/clients/search', request, headers)
       end
 
       # Updates an existing M2M Client. You can use this endpoint to activate or deactivate a M2M Client by changing its `status`. A deactivated M2M Client will not be allowed to perform future token exchange flows until it is reactivated.
@@ -285,6 +286,7 @@ module Stytch
         scopes: nil,
         trusted_metadata: nil
       )
+        headers = {}
         request = {}
         request[:client_name] = client_name unless client_name.nil?
         request[:client_description] = client_description unless client_description.nil?
@@ -292,7 +294,7 @@ module Stytch
         request[:scopes] = scopes unless scopes.nil?
         request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
 
-        put_request("/v1/m2m/clients/#{client_id}", request)
+        put_request("/v1/m2m/clients/#{client_id}", request, headers)
       end
 
       # Deletes the M2M Client.
@@ -319,7 +321,8 @@ module Stytch
       def delete(
         client_id:
       )
-        delete_request("/v1/m2m/clients/#{client_id}")
+        headers = {}
+        delete_request("/v1/m2m/clients/#{client_id}", headers)
       end
 
       # Creates a new M2M Client. On initial client creation, you may pass in a custom `client_id` or `client_secret` to import an existing M2M client. If you do not pass in a custom `client_id` or `client_secret`, one will be generated automatically. The `client_id` must be unique among all clients in your project.
@@ -365,6 +368,7 @@ module Stytch
         client_description: nil,
         trusted_metadata: nil
       )
+        headers = {}
         request = {
           scopes: scopes
         }
@@ -374,7 +378,7 @@ module Stytch
         request[:client_description] = client_description unless client_description.nil?
         request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
 
-        post_request('/v1/m2m/clients', request)
+        post_request('/v1/m2m/clients', request, headers)
       end
 
       class Secrets
@@ -408,9 +412,10 @@ module Stytch
         def rotate_start(
           client_id:
         )
+          headers = {}
           request = {}
 
-          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate/start", request)
+          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate/start", request, headers)
         end
 
         # Cancel the rotation of an M2M client secret started with the [Start Secret Rotation Endpoint](https://stytch.com/docs/b2b/api/m2m-rotate-secret-start) [Start Secret Rotation Endpoint](https://stytch.com/docs/api/m2m-rotate-secret-start).
@@ -435,9 +440,10 @@ module Stytch
         def rotate_cancel(
           client_id:
         )
+          headers = {}
           request = {}
 
-          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate/cancel", request)
+          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate/cancel", request, headers)
         end
 
         # Complete the rotation of an M2M client secret started with the [Start Secret Rotation Endpoint](https://stytch.com/docs/b2b/api/m2m-rotate-secret-start) [Start Secret Rotation Endpoint](https://stytch.com/docs/api/m2m-rotate-secret-start).
@@ -462,9 +468,10 @@ module Stytch
         def rotate(
           client_id:
         )
+          headers = {}
           request = {}
 
-          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate", request)
+          post_request("/v1/m2m/clients/#{client_id}/secrets/rotate", request, headers)
         end
       end
     end

data/lib/stytch/magic_links.rb

@@ -23,7 +23,11 @@ module Stytch
     #
     # == Parameters:
     # token::
-    #   The token to authenticate.
+    #   The Magic Link `token` from the `?token=` query parameter in the URL.
+    #
+    #       The redirect URL will look like `https://example.com/authenticate?stytch_token_type=magic_links&token=rM_kw42CWBhsHLF62V75jELMbvJ87njMe3tFVj7Qupu7`
+    #
+    #       In the redirect URL, the `stytch_token_type` will be `magic_link`. See [here](https://stytch.com/docs/guides/dashboard/redirect-urls) for more detail.
     #   The type of this field is +String+.
     # attributes::
     #   Provided attributes help with fraud detection.
@@ -99,6 +103,7 @@ module Stytch
       session_custom_claims: nil,
       code_verifier: nil
     )
+      headers = {}
       request = {
         token: token
       }
@@ -110,7 +115,7 @@ module Stytch
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
       request[:code_verifier] = code_verifier unless code_verifier.nil?
 
-      post_request('/v1/magic_links/authenticate', request)
+      post_request('/v1/magic_links/authenticate', request, headers)
     end
 
     # Create an embeddable Magic Link token for a User. Access to this endpoint is restricted. To enable it, please send us a note at support@stytch.com.
@@ -148,13 +153,14 @@ module Stytch
       expiration_minutes: nil,
       attributes: nil
     )
+      headers = {}
       request = {
         user_id: user_id
       }
       request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
       request[:attributes] = attributes unless attributes.nil?
 
-      post_request('/v1/magic_links', request)
+      post_request('/v1/magic_links', request, headers)
     end
 
     class Email
@@ -167,9 +173,7 @@ module Stytch
       # Send a magic link to an existing Stytch user using their email address. If you'd like to create a user and send them a magic link by email with one request, use our [log in or create endpoint](https://stytch.com/docs/api/log-in-or-create-user-by-email).
       #
       # ### Add an email to an existing user
-      # This endpoint also allows you to add a new email to an existing Stytch User. Including a `user_id`, `session_token`, or `session_jwt` in the request will add the email to the pre-existing Stytch User upon successful authentication.
-      #
-      # Adding a new email to an existing Stytch User requires the user to be present and validate the email via magic link. This requirement is in place to prevent account takeover attacks.
+      # This endpoint also allows you to add a new email address to an existing Stytch User. Including a `user_id`, `session_token`, or `session_jwt` in your Send Magic Link by email request will add the new, unverified email address to the existing Stytch User. If the user successfully authenticates within 5 minutes, the new email address will be marked as verified and remain permanently on the existing Stytch User. Otherwise, it will be removed from the User object, and any subsequent login requests using that email address will create a new User.
       #
       # ### Next steps
       # The user is emailed a magic link which redirects them to the provided [redirect URL](https://stytch.com/docs/guides/magic-links/email-magic-links/redirect-routing). Collect the `token` from the URL query parameters, and call [Authenticate magic link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
@@ -249,6 +253,7 @@ module Stytch
         locale: nil,
         signup_template_id: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -265,13 +270,13 @@ module Stytch
         request[:locale] = locale unless locale.nil?
         request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
 
-        post_request('/v1/magic_links/email/send', request)
+        post_request('/v1/magic_links/email/send', request, headers)
       end
 
       # Send either a login or signup Magic Link to the User based on if the email is associated with a User already. A new or pending User will receive a signup Magic Link. An active User will receive a login Magic Link. For more information on how to control the status your Users are created in see the `create_user_as_pending` flag.
       #
       # ### Next steps
-      # The User is emailed a Magic Link which redirects them to the provided [redirect URL](https://stytch.com/docs/magic-links#email-magic-links_redirect-routing). Collect the `token` from the URL query parameters and call [Authenticate Magic Link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
+      # The User is emailed a Magic Link which redirects them to the provided [redirect URL](https://stytch.com/docs/guides/magic-links/email-magic-links/redirect-routing). Collect the `token` from the URL query parameters and call [Authenticate Magic Link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
       #
       # == Parameters:
       # email::
@@ -347,6 +352,7 @@ module Stytch
         code_challenge: nil,
         locale: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -361,13 +367,13 @@ module Stytch
         request[:code_challenge] = code_challenge unless code_challenge.nil?
         request[:locale] = locale unless locale.nil?
 
-        post_request('/v1/magic_links/email/login_or_create', request)
+        post_request('/v1/magic_links/email/login_or_create', request, headers)
       end
 
       # Create a User and send an invite Magic Link to the provided `email`. The User will be created with a `pending` status until they click the Magic Link in the invite email.
       #
       # ### Next steps
-      # The User is emailed a Magic Link which redirects them to the provided [redirect URL](https://stytch.com/docs/magic-links#email-magic-links_redirect-routing). Collect the `token` from the URL query parameters and call [Authenticate Magic Link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
+      # The User is emailed a Magic Link which redirects them to the provided [redirect URL](https://stytch.com/docs/guides/magic-links/email-magic-links/redirect-routing). Collect the `token` from the URL query parameters and call [Authenticate Magic Link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
       #
       # == Parameters:
       # email::
@@ -420,6 +426,7 @@ module Stytch
         invite_expiration_minutes: nil,
         locale: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -430,7 +437,7 @@ module Stytch
         request[:invite_expiration_minutes] = invite_expiration_minutes unless invite_expiration_minutes.nil?
         request[:locale] = locale unless locale.nil?
 
-        post_request('/v1/magic_links/email/invite', request)
+        post_request('/v1/magic_links/email/invite', request, headers)
       end
 
       # Revoke a pending invite based on the `email` provided.
@@ -451,11 +458,12 @@ module Stytch
       def revoke_invite(
         email:
       )
+        headers = {}
         request = {
           email: email
         }
 
-        post_request('/v1/magic_links/email/revoke_invite', request)
+        post_request('/v1/magic_links/email/revoke_invite', request, headers)
       end
     end
   end

data/lib/stytch/method_options.rb

@@ -0,0 +1,22 @@
+module Stytch
+  module MethodOptions
+    class Authorization
+      # A secret token for a given Stytch Session.
+      attr_accessor :session_token
+      # The JSON Web Token (JWT) for a given Stytch Session.
+      attr_accessor :session_jwt
+
+      def initialize(session_token: nil, session_jwt: nil)
+        @session_token = session_token
+        @session_jwt = session_jwt
+      end
+
+      def to_headers
+        headers = {}
+        headers['X-Stytch-Member-Session'] = session_token if session_token
+        headers['X-Stytch-Member-SessionJWT'] = session_jwt if session_jwt
+        headers
+      end
+    end
+  end
+end

data/lib/stytch/oauth.rb

@@ -53,6 +53,7 @@ module Stytch
       session_token: nil,
       session_jwt: nil
     )
+      headers = {}
       request = {
         provider: provider
       }
@@ -60,14 +61,18 @@ module Stytch
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-      post_request('/v1/oauth/attach', request)
+      post_request('/v1/oauth/attach', request, headers)
     end
 
     # Authenticate a User given a `token`. This endpoint verifies that the user completed the OAuth flow by verifying that the token is valid and hasn't expired. To initiate a Stytch session for the user while authenticating their OAuth token, include `session_duration_minutes`; a session with the identity provider, e.g. Google or Facebook, will always be initiated upon successful authentication.
     #
     # == Parameters:
     # token::
-    #   The token to authenticate.
+    #   The OAuth `token` from the `?token=` query parameter in the URL.
+    #
+    #       The redirect URL will look like `https://example.com/authenticate?stytch_token_type=oauth&token=rM_kw42CWBhsHLF62V75jELMbvJ87njMe3tFVj7Qupu7`
+    #
+    #       In the redirect URL, the `stytch_token_type` will be `oauth`. See [here](https://stytch.com/docs/guides/dashboard/redirect-urls) for more detail.
     #   The type of this field is +String+.
     # session_token::
     #   Reuse an existing session instead of creating a new one. If you provide us with a `session_token`, then we'll update the session represented by this session token with this OAuth factor. If this `session_token` belongs to a different user than the OAuth token, the session_jwt will be ignored. This endpoint will error if both `session_token` and `session_jwt` are provided.
@@ -118,7 +123,7 @@ module Stytch
     # provider_values::
     #   The `provider_values` object lists relevant identifiers, values, and scopes for a given OAuth provider. For example this object will include a provider's `access_token` that you can use to access the provider's API for a given user.
     #
-    #   Note that these values will vary based on the OAuth provider in question, e.g. `id_token` is only returned by OIDC complaint identity providers.
+    #   Note that these values will vary based on the OAuth provider in question, e.g. `id_token` is only returned by OIDC compliant identity providers.
     #   The type of this field is +ProviderValues+ (+object+).
     # user::
     #   The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
@@ -146,6 +151,7 @@ module Stytch
       session_custom_claims: nil,
       code_verifier: nil
     )
+      headers = {}
       request = {
         token: token
       }
@@ -155,7 +161,7 @@ module Stytch
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
       request[:code_verifier] = code_verifier unless code_verifier.nil?
 
-      post_request('/v1/oauth/authenticate', request)
+      post_request('/v1/oauth/authenticate', request, headers)
     end
   end
 end