stytch 10.4.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e10e6ac8ac2eec46d10f87c54abef776a7217123571f3344f24f553172fe0e4
-  data.tar.gz: 5c7c08cbca050b96bf0442fcec4378aafb64ce06530d5583cec41ae6ac04eac2
+  metadata.gz: c7a83bb6fc8a15b7c439e4cf6f987491baa4376b6e90eae604d2d815b868bdd1
+  data.tar.gz: 760982754bff8b9db9d7d5637f7bb198fd147f3f4eed6a3a4678ba0f86acbcc8
 SHA512:
-  metadata.gz: 41569f0f814ceee210352b488088b9170e6f1ebaa7ad3d03382581b4eb705373deb6287024ce1f06ec7349cefeb08b3008a2e7ec9f65ae0d374fc5a6fdea7164
-  data.tar.gz: 704d6b69e6b5d286bf8da95c1f47e6f574cf9febb77f74d5711f281b0e045b63c24ce75da4d7cf20382af5a8a2f0662d9722bbd335432df3510e6d79af47f064
+  metadata.gz: 7721ae6335a51bc6858f877520c17b846265c1262a04de8f25c5d0c339aec4749359e6467ef52ce36ad54c4a5a9cc47afacef584cead680599f1880e5c47fc76
+  data.tar.gz: fabb5b4741fb4a906d13d97e04c3c8e15d4f9e923839c4b682fd17db53eec9ae09be74c5d97566161fb2e0a412867cbff191632ad8ed8bf1283d0c665f94ae08

data/lib/stytch/b2b_sessions.rb

@@ -414,11 +414,11 @@ module StytchB2B
 
     # Get the JSON Web Key Set (JWKS) for a project.
     #
-    # JWKS are rotated every ~6 months. Upon rotation, new JWTs will be signed using the new key set, and both key sets will be returned by this endpoint for a period of 1 month.
+    # JWKS are rotated every ~6 months. Upon rotation, new JWTs will be signed using the new key, and both keys will be returned by this endpoint for a period of 1 month.
     #
     # JWTs have a set lifetime of 5 minutes, so there will be a 5 minute period where some JWTs will be signed by the old JWKS, and some JWTs will be signed by the new JWKS. The correct JWKS to use for validation is determined by matching the `kid` value of the JWT and JWKS.
     #
-    # If you're using one of our [backend SDKs](https://stytch.com/docs/b2b/sdks), the JWKS roll will be handled for you.
+    # If you're using one of our [backend SDKs](https://stytch.com/docs/b2b/sdks), the JWKS rotation will be handled for you.
     #
     # If you're using your own JWT validation library, many have built-in support for JWKS rotation, and you'll just need to supply this API endpoint. If not, your application should decide which JWKS to use for validation by inspecting the `kid` value.
     #
@@ -432,7 +432,7 @@ module StytchB2B
     # == Returns:
     # An object with the following fields:
     # keys::
-    #   The JWK
+    #   The list of JWKs associated with the project.
     #   The type of this field is list of +JWK+ (+object+).
     # 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.

data/lib/stytch/client.rb

@@ -2,6 +2,7 @@
 
 require_relative 'crypto_wallets'
 require_relative 'fraud'
+require_relative 'impersonation'
 require_relative 'm2m'
 require_relative 'magic_links'
 require_relative 'oauth'
@@ -17,7 +18,7 @@ module Stytch
   class Client
     ENVIRONMENTS = %i[live test].freeze
 
-    attr_reader :crypto_wallets, :fraud, :m2m, :magic_links, :oauth, :otps, :passwords, :project, :sessions, :totps, :users, :webauthn
+    attr_reader :crypto_wallets, :fraud, :impersonation, :m2m, :magic_links, :oauth, :otps, :passwords, :project, :sessions, :totps, :users, :webauthn
 
     def initialize(project_id:, secret:, env: nil, fraud_env: nil, &block)
       @api_host = api_host(env, project_id)
@@ -30,6 +31,7 @@ module Stytch
 
       @crypto_wallets = Stytch::CryptoWallets.new(@connection)
       @fraud = Stytch::Fraud.new(@fraud_connection)
+      @impersonation = Stytch::Impersonation.new(@connection)
       @m2m = Stytch::M2M.new(@connection, @project_id, @is_b2b_client)
       @magic_links = Stytch::MagicLinks.new(@connection)
       @oauth = Stytch::OAuth.new(@connection)

data/lib/stytch/impersonation.rb

@@ -0,0 +1,64 @@
+# 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 Stytch
+  class Impersonation
+    include Stytch::RequestHelper
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Authenticate an impersonation token to impersonate a User. This endpoint requires an impersonation token that is not expired or previously used.
+    # A Stytch session will be created for the impersonated user with a 60 minute duration. Impersonated sessions cannot be extended.
+    #
+    # == Parameters:
+    # impersonation_token::
+    #   The User Impersonation token to authenticate.
+    #   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+.
+    # user_id::
+    #   The unique ID of the affected User.
+    #   The type of this field is +String+.
+    # 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.
+    #   The type of this field is +User+ (+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+.
+    # session::
+    #   If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response.
+    #
+    #   See [GET sessions](https://stytch.com/docs/api/session-get) for complete response fields.
+    #
+    #   The type of this field is nilable +Session+ (+object+).
+    def authenticate(
+      impersonation_token:
+    )
+      headers = {}
+      request = {
+        impersonation_token: impersonation_token
+      }
+
+      post_request('/v1/impersonation/authenticate', request, headers)
+    end
+  end
+end

data/lib/stytch/sessions.rb

@@ -222,11 +222,11 @@ module Stytch
 
     # Get the JSON Web Key Set (JWKS) for a project.
     #
-    # JWKS are rotated every ~6 months. Upon rotation, new JWTs will be signed using the new key set, and both key sets will be returned by this endpoint for a period of 1 month.
+    # JWKS are rotated every ~6 months. Upon rotation, new JWTs will be signed using the new key, and both keys will be returned by this endpoint for a period of 1 month.
     #
     # JWTs have a set lifetime of 5 minutes, so there will be a 5 minute period where some JWTs will be signed by the old JWKS, and some JWTs will be signed by the new JWKS. The correct JWKS to use for validation is determined by matching the `kid` value of the JWT and JWKS.
     #
-    # If you're using one of our [backend SDKs](https://stytch.com/docs/sdks), the JWKS roll will be handled for you.
+    # If you're using one of our [backend SDKs](https://stytch.com/docs/sdks), the JWKS rotation will be handled for you.
     #
     # If you're using your own JWT validation library, many have built-in support for JWKS rotation, and you'll just need to supply this API endpoint. If not, your application should decide which JWKS to use for validation by inspecting the `kid` value.
     #
@@ -240,7 +240,7 @@ module Stytch
     # == Returns:
     # An object with the following fields:
     # keys::
-    #   The JWK
+    #   The list of JWKs associated with the project.
     #   The type of this field is list of +JWK+ (+object+).
     # 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.

data/lib/stytch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 10.4.0
+  version: 10.5.0
 platform: ruby
 authors:
 - stytch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -142,6 +142,7 @@ files:
 - lib/stytch/crypto_wallets.rb
 - lib/stytch/errors.rb
 - lib/stytch/fraud.rb
+- lib/stytch/impersonation.rb
 - lib/stytch/m2m.rb
 - lib/stytch/magic_links.rb
 - lib/stytch/method_options.rb