stytch 7.7.0 → 7.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 596a877d7f9b69bdba72760f0fa015ff8d2c9e5a70959b52bcad95f1717aecee
-  data.tar.gz: 11d3704cb3e3f1d984fb1242d9219a85620d630c1a668e56b10f6a19561c6183
+  metadata.gz: ff5a6a36c47c302ec6cbcd712b1c428d392caccc0d423973130c209389a9064a
+  data.tar.gz: 4eccfd119a8f6b3332c37bbe317eeece7b4dd67f2ee06af0f09ba2ce548cee06
 SHA512:
-  metadata.gz: ca380834e2a6f3d6d6f13b99bdad4462b71cbeff12951c062bb32206ff462cd6a91957ba6c4391bb0de399b007d18ecfee1000312dcff22fd163bb48f8e0d50d
-  data.tar.gz: 5bc2d485ec0ff81b44393552668407abf09f12dae3464caa7bc4bb0329ab29acb3431590ca591e8790c8c36a25cf8fa18afbb63fc0d1853b308239e6cc2321e3
+  metadata.gz: 17200c052d42d517aaa02cf295f23799c8c9a4ccc68499277ec135cca853f9be061909fc8f4ff9e79e048c3d889312491d5d663be1df940d2619940a65f21663
+  data.tar.gz: 360d26af098aa0921781902493f669cef749d098cb2e71f0d2425eb027a40c4ea669ec4b4c1f754a0579f74de174bb01c4140415baddcb39adc16038894f98fc

data/lib/stytch/b2b_scim.rb

@@ -56,14 +56,19 @@ module StytchB2B
       # connection::
       #   The `SAML Connection` object affected by this API call. See the [SAML Connection Object](https://stytch.com/docs/b2b/api/saml-connection-object) for complete response field details.
       #   The type of this field is nilable +SCIMConnection+ (+object+).
+      #
+      # == Method Options:
+      # This method supports an optional +UpdateRequestOptions+ object which will modify the headers sent in the HTTP request.
       def update(
         organization_id:,
         connection_id:,
         display_name: nil,
         identity_provider: nil,
-        scim_group_implicit_role_assignments: nil
+        scim_group_implicit_role_assignments: nil,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {}
         request[:display_name] = display_name unless display_name.nil?
         request[:identity_provider] = identity_provider unless identity_provider.nil?
@@ -79,7 +84,7 @@ module StytchB2B
       #   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+.
       # connection_id::
-      #   Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
+      #   The ID of the SCIM connection.
       #   The type of this field is +String+.
       #
       # == Returns:
@@ -93,11 +98,16 @@ module StytchB2B
       # 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+.
+      #
+      # == Method Options:
+      # This method supports an optional +DeleteRequestOptions+ object which will modify the headers sent in the HTTP request.
       def delete(
         organization_id:,
-        connection_id:
+        connection_id:,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         delete_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}", headers)
       end
 
@@ -122,11 +132,16 @@ module StytchB2B
       # connection::
       #   The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
       #   The type of this field is nilable +SCIMConnectionWithNextToken+ (+object+).
+      #
+      # == Method Options:
+      # This method supports an optional +RotateStartRequestOptions+ object which will modify the headers sent in the HTTP request.
       def rotate_start(
         organization_id:,
-        connection_id:
+        connection_id:,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {}
 
         post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/start", request, headers)
@@ -153,11 +168,16 @@ module StytchB2B
       # connection::
       #   The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
       #   The type of this field is nilable +SCIMConnection+ (+object+).
+      #
+      # == Method Options:
+      # This method supports an optional +RotateCompleteRequestOptions+ object which will modify the headers sent in the HTTP request.
       def rotate_complete(
         organization_id:,
-        connection_id:
+        connection_id:,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {}
 
         post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/complete", request, headers)
@@ -184,11 +204,16 @@ module StytchB2B
       # connection::
       #   The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
       #   The type of this field is nilable +SCIMConnection+ (+object+).
+      #
+      # == Method Options:
+      # This method supports an optional +RotateCancelRequestOptions+ object which will modify the headers sent in the HTTP request.
       def rotate_cancel(
         organization_id:,
-        connection_id:
+        connection_id:,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {}
 
         post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/cancel", request, headers)
@@ -218,12 +243,17 @@ module StytchB2B
       # connection::
       #   The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
       #   The type of this field is nilable +SCIMConnectionWithToken+ (+object+).
+      #
+      # == Method Options:
+      # This method supports an optional +CreateRequestOptions+ object which will modify the headers sent in the HTTP request.
       def create(
         organization_id:,
         display_name: nil,
-        identity_provider: nil
+        identity_provider: nil,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         request = {}
         request[:display_name] = display_name unless display_name.nil?
         request[:identity_provider] = identity_provider unless identity_provider.nil?
@@ -249,10 +279,15 @@ module StytchB2B
       # 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+.
+      #
+      # == Method Options:
+      # This method supports an optional +GetRequestOptions+ object which will modify the headers sent in the HTTP request.
       def get(
-        organization_id:
+        organization_id:,
+        method_options: nil
       )
         headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
         query_params = {}
         request = request_with_query_params("/v1/b2b/scim/#{organization_id}/connections", query_params)
         get_request(request, headers)

data/lib/stytch/b2b_sessions.rb

@@ -316,6 +316,77 @@ module StytchB2B
       post_request('/v1/b2b/sessions/exchange', request, headers)
     end
 
+    # Migrate a session from an external OIDC compliant endpoint. Stytch will call the external UserInfo endpoint defined in your Stytch Project settings in the [Dashboard](/dashboard), and then perform a lookup using the `session_token`. If the response contains a valid email address, Stytch will attempt to match that email address with a Member in your Organization and create a Stytch Session.
+    #
+    # == Parameters:
+    # session_token::
+    #   The authorization token Stytch will pass in to the external userinfo endpoint.
+    #   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 +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+.
+    #
+    # == 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+.
+    # 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+.
+    # 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::
+    #   (no documentation yet)
+    #   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 migrate(
+      session_token:,
+      organization_id:,
+      session_duration_minutes: nil,
+      session_custom_claims: nil
+    )
+      headers = {}
+      request = {
+        session_token: session_token,
+        organization_id: organization_id
+      }
+      request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+
+      post_request('/v1/b2b/sessions/migrate', request, headers)
+    end
+
     # 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.

data/lib/stytch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 7.7.0
+  version: 7.8.1
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday