stytch 10.18.0 → 10.20.0

data/lib/stytch/users.rb

@@ -45,7 +45,7 @@ module Stytch
     #   The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
     #   The type of this field is nilable +object+.
     # external_id::
-    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters.
     #   The type of this field is nilable +String+.
     #
     # == Returns:
@@ -99,7 +99,7 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The unique ID of a specific User. You may use an external_id here if one is set for the user.
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     #
     # == Returns:
@@ -134,6 +134,9 @@ module Stytch
     # biometric_registrations::
     #   An array that contains a list of all biometric registrations for a given User in the Stytch API.
     #   The type of this field is list of +BiometricRegistration+ (+object+).
+    # is_locked::
+    #   (no documentation yet)
+    #   The type of this field is +Boolean+.
     # 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+.
@@ -155,6 +158,12 @@ module Stytch
     # external_id::
     #   (no documentation yet)
     #   The type of this field is nilable +String+.
+    # lock_created_at::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
+    # lock_expires_at::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
     def get(
       user_id:
     )
@@ -219,13 +228,13 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The unique ID of a specific User. You may use an external_id here if one is set for the user.
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     # name::
     #   The name of the user. Each field in the name object is optional.
     #   The type of this field is nilable +Name+ (+object+).
     # attributes::
-    #   Provided attributes help with fraud detection.
+    #   Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application.
     #   The type of this field is nilable +Attributes+ (+object+).
     # trusted_metadata::
     #   The `trusted_metadata` field contains an arbitrary JSON object of application-specific data. See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
@@ -234,7 +243,7 @@ module Stytch
     #   The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
     #   The type of this field is nilable +object+.
     # external_id::
-    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters.
     #   The type of this field is nilable +String+.
     #
     # == Returns:
@@ -289,7 +298,7 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The unique ID of a specific User. You may use an external_id here if one is set for the user.
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     # email_address::
     #   The email address to exchange to.
@@ -329,7 +338,7 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The unique ID of a specific User. You may use an external_id here if one is set for the user.
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     #
     # == Returns:
@@ -573,5 +582,65 @@ module Stytch
       headers = {}
       delete_request("/v1/users/oauth/#{oauth_user_registration_id}", headers)
     end
+
+    # User Get Connected Apps retrieves a list of Connected Apps with which the User has successfully completed an
+    # authorization flow.
+    # If the User revokes a Connected App's access (e.g. via the Revoke Connected App endpoint) then the Connected App will
+    # no longer be returned in the response.
+    #
+    # == Parameters:
+    # user_id::
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
+    #   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+.
+    # connected_apps::
+    #   An array of Connected Apps with which the User has successfully completed an authorization flow.
+    #   The type of this field is list of +UserConnectedApp+ (+object+).
+    # status_code::
+    #   (no documentation yet)
+    #   The type of this field is +Integer+.
+    def connected_apps(
+      user_id:
+    )
+      headers = {}
+      query_params = {}
+      request = request_with_query_params("/v1/users/#{user_id}/connected_apps", query_params)
+      get_request(request, headers)
+    end
+
+    # Revoke Connected App revokes a Connected App's access to a User and revokes all active tokens that have been created
+    # on the User's behalf. New tokens cannot be created until the User completes a new authorization flow with the
+    # Connected App.
+    #
+    # == Parameters:
+    # user_id::
+    #   The unique ID of a specific User. You may use an `external_id` here if one is set for the user.
+    #   The type of this field is +String+.
+    # connected_app_id::
+    #   The ID of the Connected App.
+    #   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+.
+    # status_code::
+    #   (no documentation yet)
+    #   The type of this field is +Integer+.
+    def revoke(
+      user_id:,
+      connected_app_id:
+    )
+      headers = {}
+      request = {}
+
+      post_request("/v1/users/#{user_id}/connected_apps/#{connected_app_id}/revoke", request, headers)
+    end
   end
 end

data/lib/stytch/version.rb

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

data/lib/stytch/webauthn.rb

@@ -26,13 +26,13 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an external_id here if one is set for the user.
+    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     # domain::
     #   The domain for Passkeys or WebAuthn. Defaults to `window.location.hostname`.
     #   The type of this field is +String+.
     # user_agent::
-    #   The user agent of the User.
+    #   The user agent of the client.
     #   The type of this field is nilable +String+.
     # authenticator_type::
     #   The requested authenticator type of the Passkey or WebAuthn device. The two valid values are platform and cross-platform. If no value passed, we assume both values are allowed.
@@ -96,7 +96,7 @@ module Stytch
     #
     # == Parameters:
     # user_id::
-    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an external_id here if one is set for the user.
+    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
     #   The type of this field is +String+.
     # public_key_credential::
     #   The response of the [navigator.credentials.create()](https://www.w3.org/TR/webauthn-2/#sctn-createCredential).
@@ -150,7 +150,7 @@ module Stytch
     # 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.
+    #   See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.
     #
     #   The type of this field is nilable +Session+ (+object+).
     def register(
@@ -187,7 +187,7 @@ module Stytch
     #   The domain for Passkeys or WebAuthn. Defaults to `window.location.hostname`.
     #   The type of this field is +String+.
     # user_id::
-    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an external_id here if one is set for the user.
+    #   The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
     #   The type of this field is nilable +String+.
     # return_passkey_credential_options::
     #   If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `userVerification` set to `"preferred"`.
@@ -280,7 +280,7 @@ module Stytch
     # 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.
+    #   See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.
     #
     #   The type of this field is nilable +Session+ (+object+).
     def authenticate(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 10.18.0
+  version: 10.20.0
 platform: ruby
 authors:
 - stytch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday