workos 5.17.1 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12928b2f29257838b9923c9a08fd1d8ac9178573bc3a2ca5a06303bf15f4eeb
-  data.tar.gz: 792fd1f5da6e34c1bcfc44c63299a82856b05fa8ddfa9acdba109da0f6aa0c19
+  metadata.gz: b64aa946db63d75ad0e7b560a904f441d2acfe4f320138c90884c5382a8da26e
+  data.tar.gz: 9038133e40d856eee210c2298739995e3aa8cceae91b1415542955c6bea16226
 SHA512:
-  metadata.gz: c97eaf5a70a9bda626f27f7bf75ea8f50021c1d26306f85ba3cf7dda14d6dd8029ba7ffd4f60f1afc1510490a54fc5f9e72dae0af904b536d05450f9d2caf00c
-  data.tar.gz: 2e9a504333658b038d92708a8f3e531c7805e1b87ab6208b95fac120d2f36a9a594aa5878c2c56eb6b9b48742d88851e8aafc914c555970fa61207789f9780c7
+  metadata.gz: c16ee35f4494b5acd119ae6a354d0ba3fa7d9e892310d8388133ff54c0e0930f3d19a20c96d3ebe5b99d7fccd8acf213eb78e6d679967c972c4c4abc15ad3cfd
+  data.tar.gz: 88a97b1723b6dd505b19e8911c6eccef2b2adda01e996959cffa73ec82d71bf85d1011e517f660085d5c388f6474dad2eb7f0b78352e5f5b458671510b936813

data/.rubocop.yml

@@ -12,10 +12,14 @@ Layout/LineLength:
     - '(\A|\s)/.*?/'
 Metrics/BlockLength:
   AllowedMethods: ['describe', 'context', 'before', 'it']
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 Metrics/MethodLength:
-  Max: 30
+  Enabled: false
 Metrics/ModuleLength:
-  Max: 200
+  Enabled: false
 Metrics/ParameterLists:
   Max: 6
 Naming/ConstantName:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (5.17.1)
+    workos (5.19.0)
       encryptor (~> 3.0)
       jwt (~> 2.8)
 

data/lib/workos/client.rb

@@ -86,7 +86,7 @@ module WorkOS
       ].join('; ')
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity:
+    # rubocop:disable Metrics/AbcSize:
     def handle_error_response(response:)
       http_status = response.code.to_i
       json = JSON.parse(response.body)

data/lib/workos/mfa.rb

@@ -32,7 +32,6 @@ module WorkOS
         WorkOS::Factor.new(response.body)
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
       def validate_args(
         type:,

data/lib/workos/session.rb

@@ -64,7 +64,6 @@ module WorkOS
     # @return [Hash] A hash containing a new sealed session, the authentication response,
     # and a reason if the refresh failed
     # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
     def refresh(options = nil)
       cookie_password = options.nil? || options[:cookie_password].nil? ? @cookie_password : options[:cookie_password]

data/lib/workos/user_management.rb

@@ -6,8 +6,6 @@ require 'uri'
 module WorkOS
   # The UserManagement module provides convenience methods for working with the
   # WorkOS User platform. You'll need a valid API key.
-
-  # rubocop:disable Metrics/ModuleLength
   module UserManagement
     module Types
       # The ProviderEnum is a declaration of a
@@ -217,6 +215,7 @@ module WorkOS
       # Update a user
       #
       # @param [String] id of the user.
+      # @param [String] email of the user.
       # @param [String] first_name The user's first name.
       # @param [String] last_name The user's last name.
       # @param [Boolean] email_verified Whether the user's email address was previously verified.
@@ -228,6 +227,7 @@ module WorkOS
       # @return [WorkOS::User]
       def update_user(
         id:,
+        email: nil,
         first_name: nil,
         last_name: nil,
         email_verified: nil,
@@ -238,6 +238,7 @@ module WorkOS
         request = put_request(
           path: "/user_management/users/#{id}",
           body: {
+            email: email,
             first_name: first_name,
             last_name: last_name,
             email_verified: email_verified,
@@ -277,9 +278,20 @@ module WorkOS
       # @param [String] client_id The WorkOS client ID for the environment
       # @param [String] ip_address The IP address of the request from the user who is attempting to authenticate.
       # @param [String] user_agent The user agent of the request from the user who is attempting to authenticate.
+      # @param [Hash] session An optional hash that determines whether the session should be sealed and
+      # the optional cookie password.
       #
       # @return WorkOS::AuthenticationResponse
-      def authenticate_with_password(email:, password:, client_id:, ip_address: nil, user_agent: nil)
+      def authenticate_with_password(
+        email:,
+        password:,
+        client_id:,
+        ip_address: nil,
+        user_agent: nil,
+        session: nil
+      )
+        validate_session(session)
+
         response = execute_request(
           request: post_request(
             path: '/user_management/authenticate',
@@ -295,7 +307,7 @@ module WorkOS
           ),
         )
 
-        WorkOS::AuthenticationResponse.new(response.body)
+        WorkOS::AuthenticationResponse.new(response.body, session)
       end
 
       # Authenticate a user using OAuth or an organization's SSO connection.
@@ -316,9 +328,7 @@ module WorkOS
         user_agent: nil,
         session: nil
       )
-        if session && (session[:seal_session] == true) && session[:cookie_password].nil?
-          raise ArgumentError, 'cookie_password is required when sealing session'
-        end
+        validate_session(session)
 
         response = execute_request(
           request: post_request(
@@ -356,9 +366,7 @@ module WorkOS
         user_agent: nil,
         session: nil
       )
-        if session && (session[:seal_session] == true) && session[:cookie_password].nil?
-          raise ArgumentError, 'cookie_password is required when sealing session'
-        end
+        validate_session(session)
 
         response = execute_request(
           request: post_request(
@@ -387,16 +395,22 @@ module WorkOS
       # @param [String] link_authorization_code Used to link an OAuth profile to an existing user,
       # after having completed a Magic Code challenge.
       # @param [String] user_agent The user agent of the request from the user who is attempting to authenticate.
+      # @param [Hash] session An optional hash that determines whether the session should be sealed and
+      # the optional cookie password.
       #
       # @return WorkOS::AuthenticationResponse
+      # rubocop:disable Metrics/ParameterLists
       def authenticate_with_magic_auth(
         code:,
         email:,
         client_id:,
         ip_address: nil,
         user_agent: nil,
-        link_authorization_code: nil
+        link_authorization_code: nil,
+        session: nil
       )
+        validate_session(session)
+
         response = execute_request(
           request: post_request(
             path: '/user_management/authenticate',
@@ -413,8 +427,9 @@ module WorkOS
           ),
         )
 
-        WorkOS::AuthenticationResponse.new(response.body)
+        WorkOS::AuthenticationResponse.new(response.body, session)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # Authenticate a user into an organization they are a member of.
       #
@@ -423,6 +438,8 @@ module WorkOS
       # @param [String] pending_authentication_token The pending authentication token
       # @param [String] ip_address The IP address of the request from the user who is attempting to authenticate.
       # @param [String] user_agent The user agent of the request from the user who is attempting to authenticate.
+      # @param [Hash] session An optional hash that determines whether the session should be sealed and
+      # the optional cookie password.
       #
       # @return WorkOS::AuthenticationResponse
       def authenticate_with_organization_selection(
@@ -430,8 +447,11 @@ module WorkOS
         organization_id:,
         pending_authentication_token:,
         ip_address: nil,
-        user_agent: nil
+        user_agent: nil,
+        session: nil
       )
+        validate_session(session)
+
         response = execute_request(
           request: post_request(
             path: '/user_management/authenticate',
@@ -447,7 +467,7 @@ module WorkOS
           ),
         )
 
-        WorkOS::AuthenticationResponse.new(response.body)
+        WorkOS::AuthenticationResponse.new(response.body, session)
       end
 
       # Authenticate a user using TOTP.
@@ -460,16 +480,22 @@ module WorkOS
       # authentication request.
       # @param [String] ip_address The IP address of the request from the user who is attempting to authenticate.
       # @param [String] user_agent The user agent of the request from the user who is attempting to authenticate.
+      # @param [Hash] session An optional hash that determines whether the session should be sealed and
+      # the optional cookie password.
       #
       # @return WorkOS::AuthenticationResponse
+      # rubocop:disable Metrics/ParameterLists
       def authenticate_with_totp(
         code:,
         client_id:,
         pending_authentication_token:,
         authentication_challenge_id:,
         ip_address: nil,
-        user_agent: nil
+        user_agent: nil,
+        session: nil
       )
+        validate_session(session)
+
         response = execute_request(
           request: post_request(
             path: '/user_management/authenticate',
@@ -486,8 +512,9 @@ module WorkOS
           ),
         )
 
-        WorkOS::AuthenticationResponse.new(response.body)
+        WorkOS::AuthenticationResponse.new(response.body, session)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # Authenticate a user using Email Verification Code.
       #
@@ -497,6 +524,8 @@ module WorkOS
       # authentication attempt due to an unverified email address.
       # @param [String] ip_address The IP address of the request from the user who is attempting to authenticate.
       # @param [String] user_agent The user agent of the request from the user who is attempting to authenticate.
+      # @param [Hash] session An optional hash that determines whether the session should be sealed and
+      # the optional cookie password.
       #
       # @return WorkOS::AuthenticationResponse
       def authenticate_with_email_verification(
@@ -504,8 +533,11 @@ module WorkOS
         client_id:,
         pending_authentication_token:,
         ip_address: nil,
-        user_agent: nil
+        user_agent: nil,
+        session: nil
       )
+        validate_session(session)
+
         response = execute_request(
           request: post_request(
             path: '/user_management/authenticate',
@@ -521,7 +553,7 @@ module WorkOS
           ),
         )
 
-        WorkOS::AuthenticationResponse.new(response.body)
+        WorkOS::AuthenticationResponse.new(response.body, session)
       end
 
       # Get the logout URL for a session
@@ -1081,6 +1113,12 @@ module WorkOS
 
       private
 
+      def validate_session(session)
+        return unless session && (session[:seal_session] == true) && session[:cookie_password].nil?
+
+        raise ArgumentError, 'cookie_password is required when sealing session'
+      end
+
       def validate_authorization_url_arguments(
         provider:,
         connection_id:,

data/lib/workos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkOS
-  VERSION = '5.17.1'
+  VERSION = '5.19.0'
 end

data/spec/lib/workos/user_management_spec.rb

@@ -343,6 +343,17 @@ describe WorkOS::UserManagement do
         end
       end
 
+      it 'can update email addresses' do
+        VCR.use_cassette 'user_management/update_user/email' do
+          user = described_class.update_user(
+            id: 'user_01H7TVSKS45SDHN5V9XPSM6H44',
+            email: 'jane@example.com',
+          )
+          expect(user.email).to eq('jane@example.com')
+          expect(user.email_verified).to eq(false)
+        end
+      end
+
       context 'with an invalid payload' do
         it 'returns an error' do
           VCR.use_cassette 'user_management/update_user/invalid' do

data/spec/support/fixtures/vcr_cassettes/user_management/update_user/email.yml

@@ -0,0 +1,82 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.workos.com/user_management/users/user_01H7TVSKS45SDHN5V9XPSM6H44
+    body:
+      encoding: UTF-8
+      string: '{"email":"jane@example.com"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.0.2; arm64-darwin21; v2.16.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 25 Aug 2023 23:37:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 7fc7a9287d0330ba-SEA
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"153-w5d8Z7u7b9Obt9NziECtNSAY9Ac"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (devel)
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - b333b9e1-c9ec-4e99-ae4f-17a854859cf1
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=adC6w3NUNGTpdZDzNn39guANJ9wi798uCuqc_EI8190-1693006624-0-AcpsuyzFE/KdM7ev5pSVTt2vnGqCSZBOuQYZ0iKFiJT0mBlAuNITn3hICEKvcZ4LH7JUIyjnEOWfq2w7JyRmrJ4=;
+        path=/; expires=Sat, 26-Aug-23 00:07:04 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=1d0cc3edf886cc7b90bd0c9c3226f5611a385c1a-1693006624; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"user","id":"user_01H7TVSKS45SDHN5V9XPSM6H44","email":"jane@example.com","email_verified":false,"first_name":"Jane","last_name":"Doe","created_at":"2023-08-14T20:28:58.929Z","updated_at":"2023-08-25T22:57:44.262Z","user_type":"unmanaged","email_verified_at":null,"google_oauth_profile_id":null,"microsoft_oauth_profile_id":null}'
+    http_version:
+  recorded_at: Fri, 12 May 2025 23:37:04 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 5.17.1
+  version: 5.19.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: encryptor
@@ -368,6 +368,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_organization_membership/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/email.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user_password/invalid.yml
@@ -590,6 +591,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/user_management/send_verification_email/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_organization_membership/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_organization_membership/valid.yml
+- spec/support/fixtures/vcr_cassettes/user_management/update_user/email.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user/invalid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user/valid.yml
 - spec/support/fixtures/vcr_cassettes/user_management/update_user_password/invalid.yml