stytch 5.0.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ee430e74726ce2a8dd22451dfeec1506301ceabd017c32ef1f58ae7cc25492
-  data.tar.gz: c796fe06cc8f05fe0ca282531e3faf8d27a034e325119a564c2c80bb410d83ab
+  metadata.gz: 734345852cfe96eb50bcbb218b9757310c0f324b1326b96488cff983d4b4cc29
+  data.tar.gz: 62be1b92820bf7ef7cba5a0956bcdab696e13aee6f69acb0f68de9ae17f7b134
 SHA512:
-  metadata.gz: 294abc2a28d9b4d5836353ceeef68ae834519de7058c399a479e3879012ffd9e71ba82dce1dd7adda34fd0468b3cca6a4c7bf6febc80049763a3b4d7ac14700f
-  data.tar.gz: 86a961039cc51b22a936f4dd03e6a8eacff65eb9d3e4c4ff13ba224a048c53abfb9569ab24aec5bfc508a9d216278ba961f12c8f69cc348a0b06b7d2cfb64c80
+  metadata.gz: 58db37330e6d76f2d95747a678f5de69ce5e831b2e293bf5e316fc5afb130a303399fdf3d64fb2e2ee1efc4f3c219712b9e06a3c3b34ffda7549ebdbac9fedf3
+  data.tar.gz: 4cf8c4f8201e6717594a64d68584fd073f18b52674df440c1f53add007ac1a0f8f7867c99b5889984a587fff291ab75231fb5b470037b08ab9600a46307118e8

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 *.gem
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/lib/stytch/b2b_client.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'b2b_discovery'
 require_relative 'b2b_magic_links'
+require_relative 'b2b_oauth'
 require_relative 'b2b_organizations'
+require_relative 'b2b_otp'
 require_relative 'b2b_passwords'
 require_relative 'b2b_sessions'
 require_relative 'b2b_sso'
@@ -10,7 +13,7 @@ module StytchB2B
   class Client
     ENVIRONMENTS = %i[live test].freeze
 
-    attr_reader :magic_links, :organizations, :passwords, :sso, :sessions
+    attr_reader :discovery, :magic_links, :oauth, :otps, :organizations, :passwords, :sso, :sessions
 
     def initialize(project_id:, secret:, env: nil, &block)
       @api_host   = api_host(env, project_id)
@@ -19,7 +22,10 @@ module StytchB2B
 
       create_connection(&block)
 
+      @discovery = StytchB2B::Discovery.new(@connection)
       @magic_links = StytchB2B::MagicLinks.new(@connection)
+      @oauth = StytchB2B::OAuth.new(@connection)
+      @otps = StytchB2B::OTPs.new(@connection)
       @organizations = StytchB2B::Organizations.new(@connection)
       @passwords = StytchB2B::Passwords.new(@connection)
       @sso = StytchB2B::SSO.new(@connection)

data/lib/stytch/b2b_discovery.rb

@@ -1,5 +1,11 @@
 # 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
@@ -21,11 +27,72 @@ module StytchB2B
         @connection = connection
       end
 
+      # Exchange an Intermediate Session for a fully realized [Member Session](https://stytch.com/docs/b2b/api/session-object) in a desired [Organization](https://stytch.com/docs/b2b/api/organization-object).
+      # This operation consumes the Intermediate Session.
+      #
+      # This endpoint can be used to accept invites and create new members via domain matching.
+      #
+      # == Parameters:
+      # intermediate_session_token::
+      #   The Intermediate Session Token. This token does not belong to a specific instance of a member, but may be exchanged for an existing Member Session or used to create a new organization.
+      #   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+.
+      # locale::
+      #   (no documentation yet)
+      #   The type of this field is nilable +ExchangeRequestLocale+ (string enum).
+      #
+      # == 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::
+      #   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 exchange(
         intermediate_session_token:,
         organization_id:,
         session_duration_minutes: nil,
-        session_custom_claims: nil
+        session_custom_claims: nil,
+        locale: nil
       )
         request = {
           intermediate_session_token: intermediate_session_token,
@@ -33,6 +100,7 @@ module StytchB2B
         }
         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[:locale] = locale unless locale.nil?
 
         post_request('/v1/b2b/discovery/intermediate_sessions/exchange', request)
       end
@@ -45,6 +113,125 @@ module StytchB2B
         @connection = connection
       end
 
+      # If an end user does not want to join any already-existing organization, or has no possible organizations to join, this endpoint can be used to create a new
+      # [Organization](https://stytch.com/docs/b2b/api/organization-object) and [Member](https://stytch.com/docs/b2b/api/member-object).
+      #
+      # This operation consumes the Intermediate Session.
+      #
+      # This endpoint can also be used to start an initial session for the newly created member and organization.
+      #
+      # == Parameters:
+      # intermediate_session_token::
+      #   The Intermediate Session Token. This token does not belong to a specific instance of a member, but may be exchanged for an existing Member Session or used to create a new organization.
+      #   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
+      #   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+.
+      # organization_logo_url::
+      #   The image URL of the Organization logo.
+      #   The type of this field is nilable +String+.
+      # trusted_metadata::
+      #   An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
+      #   The type of this field is nilable +object+.
+      # sso_jit_provisioning::
+      #   The authentication setting that controls the JIT provisioning of Members when authenticating via SSO. The accepted values are:
+      #
+      #   `ALL_ALLOWED` – new Members will be automatically provisioned upon successful authentication via any of the Organization's `sso_active_connections`.
+      #
+      #   `RESTRICTED` – only new Members with SSO logins that comply with `sso_jit_provisioning_allowed_connections` can be provisioned upon authentication.
+      #
+      #   `NOT_ALLOWED` – disable JIT provisioning via SSO.
+      #
+      #   The type of this field is nilable +String+.
+      # email_allowed_domains::
+      #   An array of email domains that allow invites or JIT provisioning for new Members. This list is enforced when either `email_invites` or `email_jit_provisioning` is set to `RESTRICTED`.
+      #
+      #
+      #     Common domains such as `gmail.com` are not allowed. See the [common email domains resource](https://stytch.com/docs/b2b/api/common-email-domains) for the full list.
+      #   The type of this field is nilable list of +String+.
+      # email_jit_provisioning::
+      #   The authentication setting that controls how a new Member can be provisioned by authenticating via Email Magic Link. The accepted values are:
+      #
+      #   `RESTRICTED` – only new Members with verified emails that comply with `email_allowed_domains` can be provisioned upon authentication via Email Magic Link.
+      #
+      #   `NOT_ALLOWED` – disable JIT provisioning via Email Magic Link.
+      #
+      #   The type of this field is nilable +String+.
+      # email_invites::
+      #   The authentication setting that controls how a new Member can be invited to an organization by email. The accepted values are:
+      #
+      #   `ALL_ALLOWED` – any new Member can be invited to join via email.
+      #
+      #   `RESTRICTED` – only new Members with verified emails that comply with `email_allowed_domains` can be invited via email.
+      #
+      #   `NOT_ALLOWED` – disable email invites.
+      #
+      #   The type of this field is nilable +String+.
+      # auth_methods::
+      #   The setting that controls which authentication methods can be used by Members of an Organization. The accepted values are:
+      #
+      #   `ALL_ALLOWED` – the default setting which allows all authentication methods to be used.
+      #
+      #   `RESTRICTED` – only methods that comply with `allowed_auth_methods` can be used for authentication. This setting does not apply to Members with `is_breakglass` set to `true`.
+      #
+      #   The type of this field is nilable +String+.
+      # allowed_auth_methods::
+      #
+      #   An array of allowed authentication methods. This list is enforced when `auth_methods` is set to `RESTRICTED`.
+      #   The list's accepted values are: `sso`, `magic_link`, `password`, `google_oauth`, and `microsoft_oauth`.
+      #
+      #   The type of this field is nilable list of +String+.
+      # mfa_policy::
+      #   (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+.
+      # 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+).
+      # 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+).
+      # organization::
+      #   The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
+      #   The type of this field is nilable +Organization+ (+object+).
       def create(
         intermediate_session_token:,
         organization_name:,
@@ -58,7 +245,8 @@ module StytchB2B
         email_jit_provisioning: nil,
         email_invites: nil,
         auth_methods: nil,
-        allowed_auth_methods: nil
+        allowed_auth_methods: nil,
+        mfa_policy: nil
       )
         request = {
           intermediate_session_token: intermediate_session_token,
@@ -75,16 +263,68 @@ module StytchB2B
         request[:email_invites] = email_invites unless email_invites.nil?
         request[:auth_methods] = auth_methods unless auth_methods.nil?
         request[:allowed_auth_methods] = allowed_auth_methods unless allowed_auth_methods.nil?
+        request[:mfa_policy] = mfa_policy unless mfa_policy.nil?
 
         post_request('/v1/b2b/discovery/organizations/create', request)
       end
 
+      # List all possible organization relationships connected to a [Member Session](https://stytch.com/docs/b2b/api/session-object) or Intermediate Session.
+      #
+      # When a Member Session is passed in, relationships with a type of `active_member`, `pending_member`, or `invited_member`
+      # will be returned, and any membership can be assumed by calling the [Exchange Session](https://stytch.com/docs/b2b/api/exchange-session) endpoint.
+      #
+      # When an Intermediate Session is passed in, all relationship types - `active_member`, `pending_member`, `invited_member`,
+      # and `eligible_to_join_by_email_domain` - will be returned,
+      # and any membership can be assumed by calling the [Exchange Intermediate Session](https://stytch.com/docs/b2b/api/exchange-intermediate-session) endpoint.
+      #
+      # This endpoint requires either an `intermediate_session_token`, `session_jwt` or `session_token` be included in the request.
+      # It will return an error if multiple are present.
+      #
+      # This operation does not consume the Intermediate Session or Session Token passed in.
+      #
+      # == Parameters:
+      # intermediate_session_token::
+      #   The Intermediate Session Token. This token does not belong to a specific instance of a member, but may be exchanged for an existing Member Session or used to create a new organization.
+      #   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+.
+      # email_address::
+      #   The email address.
+      #   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 list(
         intermediate_session_token: nil,
         session_token: nil,
         session_jwt: nil
       )
-        request = {}
+        request = {
+        }
         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?