workos 5.23.0 → 5.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840052dd55f646d6ae09f2c0e0a4c91a6686d0f4fcb3b9da66b13fa3e4f835eb
-  data.tar.gz: cb5807f1a8b0b1fe28f21e5c8cfa84fd3c75e68bf7e743f9f95a5ac1787efd55
+  metadata.gz: 86d12c42e6f45139b343d1f519807176eca7a9ac77dbd2d3de0287a9406c50c4
+  data.tar.gz: 3addd0959c8b7b8c2caae994b694bfda1eabe41499f540d76e71865e9ae9b35f
 SHA512:
-  metadata.gz: fccea79a69343e4deeb1f25e076dfc19febbd5a540bd0e9e55ad6f4859ef3332a300e1f023e74c8bad7c16fe1c2b7266eb8bc5dfd600ddb0d40e036ff48d739f
-  data.tar.gz: b49a2c19e2360811203f8b07806a198bd7b9307dc654b72fb266311ff7fbf881b0cb142159a67144c25057d340e3d4fdd11bba1fc42e509bf05fcf427dcd9a48
+  metadata.gz: e286d3aa2d010bbab396d9267795c9eee35cac00f7d3c4c95fb35d70b08df133d32b0081a5f83a1ecf1fe28d663f660947b27756b7225a22ed7b345d4e5d5898
+  data.tar.gz: 9571637a3bda0ce330a54ea0a8a09076905fdece0b2e85565a3dd9510d5c3f27d52021cca7a51372d7bc0c3de00a7aeaacb521e0522b9a849df8081d5c316828

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (5.23.0)
+    workos (5.25.0)
       encryptor (~> 3.0)
       jwt (~> 2.8)
 
@@ -32,7 +32,6 @@ GEM
     rainbow (3.1.1)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-      strscan
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -59,11 +58,11 @@ GEM
     rubocop-ast (1.37.0)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    vcr (5.0.0)
+    vcr (6.3.1)
+      base64
     webmock (3.23.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -76,7 +75,7 @@ DEPENDENCIES
   bundler (>= 2.0.1)
   rspec (~> 3.9.0)
   rubocop (~> 1.71)
-  vcr (~> 5.0.0)
+  vcr (~> 6.0)
   webmock
   workos!
 

data/lib/workos/feature_flag.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WorkOS
+  # The FeatureFlag class provides a lightweight wrapper around
+  # a WorkOS Feature Flag resource. This class is not meant to be instantiated
+  # in user space, and is instantiated internally but exposed.
+  class FeatureFlag
+    include HashProvider
+
+    attr_accessor :id, :name, :slug, :description, :created_at, :updated_at
+
+    def initialize(json)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @name = hash[:name]
+      @slug = hash[:slug]
+      @description = hash[:description]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+        slug: slug,
+        description: description,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+  end
+end

data/lib/workos/organizations.rb

@@ -224,6 +224,46 @@ module WorkOS
         )
       end
 
+      # Retrieve a list of feature flags for the given organization.
+      #
+      # @param [String] organization_id The ID of the organization to fetch feature flags for.
+      # @param [Hash] options
+      # @option options [String] before A pagination argument used to request
+      #  feature flags before the provided FeatureFlag ID.
+      # @option options [String] after A pagination argument used to request
+      #  feature flags after the provided FeatureFlag ID.
+      # @option options [Integer] limit A pagination argument used to limit the number
+      #  of listed FeatureFlags that are returned.
+      # @option options [String] order The order in which to paginate records
+      #
+      # @example
+      #   WorkOS::Organizations.list_organization_feature_flags(organization_id: 'org_01EHZNVPK3SFK441A1RGBFSHRT')
+      #   => #<WorkOS::Types::ListStruct data=[#<WorkOS::FeatureFlag id="flag_123" slug="new-feature"
+      #                                         enabled=true ...>] ...>
+      #
+      # @return [WorkOS::Types::ListStruct] - Collection of FeatureFlag objects
+      def list_organization_feature_flags(organization_id:, options: {})
+        options[:order] ||= 'desc'
+        response = execute_request(
+          request: get_request(
+            path: "/organizations/#{organization_id}/feature-flags",
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+
+        feature_flags = parsed_response['data'].map do |feature_flag|
+          WorkOS::FeatureFlag.new(feature_flag.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: feature_flags,
+          list_metadata: parsed_response['list_metadata']&.transform_keys(&:to_sym),
+        )
+      end
+
       private
 
       def check_and_raise_organization_error(response:)

data/lib/workos/user_management.rb

@@ -69,6 +69,8 @@ module WorkOS
       #  that is preserved and available to the client in the response.
       # @param [String] login_hint Can be used to pre-fill the username/email address
       # field of the IdP sign-in page for the user, if you know their username ahead of time.
+      # @param [String] screen_hint Specify which AuthKit screen users should land on upon redirection
+      # (Only applicable when provider is 'authkit').
       # @param [String] domain_hint Can be used to pre-fill the domain field when
       # initiating authentication with Microsoft OAuth, or with a GoogleSAML connection type.
       # @param [Array<String>] provider_scopes An array of additional OAuth scopes to request from the provider.
@@ -94,6 +96,7 @@ module WorkOS
         client_id: nil,
         domain_hint: nil,
         login_hint: nil,
+        screen_hint: nil,
         provider: nil,
         connection_id: nil,
         organization_id: nil,
@@ -114,6 +117,7 @@ module WorkOS
           state: state,
           domain_hint: domain_hint,
           login_hint: login_hint,
+          screen_hint: screen_hint,
           provider: provider,
           connection_id: connection_id,
           organization_id: organization_id,

data/lib/workos/version.rb

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

data/lib/workos.rb

@@ -59,6 +59,7 @@ module WorkOS
   autoload :Event, 'workos/event'
   autoload :Events, 'workos/events'
   autoload :Factor, 'workos/factor'
+  autoload :FeatureFlag, 'workos/feature_flag'
   autoload :Impersonator, 'workos/impersonator'
   autoload :Invitation, 'workos/invitation'
   autoload :MagicAuth, 'workos/magic_auth'

data/spec/lib/workos/organizations_spec.rb

@@ -450,4 +450,120 @@ describe WorkOS::Organizations do
       end
     end
   end
+
+  describe '.list_organization_feature_flags' do
+    context 'with no options' do
+      it 'returns feature flags for organization' do
+        expected_metadata = {
+          after: nil,
+          before: nil,
+        }
+
+        VCR.use_cassette 'organization/list_organization_feature_flags' do
+          feature_flags = described_class.list_organization_feature_flags(
+            organization_id: 'org_01HX7Q7R12H1JMAKN75SH2G529',
+          )
+
+          expect(feature_flags.data.size).to eq(2)
+          expect(feature_flags.list_metadata).to eq(expected_metadata)
+        end
+      end
+    end
+
+    context 'with the before option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations/org_01HX7Q7R12H1JMAKN75SH2G529/feature-flags?before=before-id&'\
+          'order=desc',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list_organization_feature_flags', match_requests_on: [:path] do
+          feature_flags = described_class.list_organization_feature_flags(
+            organization_id: 'org_01HX7Q7R12H1JMAKN75SH2G529',
+            options: { before: 'before-id' },
+          )
+
+          expect(feature_flags.data.size).to eq(2)
+        end
+      end
+    end
+
+    context 'with the after option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations/org_01HX7Q7R12H1JMAKN75SH2G529/feature-flags?after=after-id&'\
+          'order=desc',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list_organization_feature_flags', match_requests_on: [:path] do
+          feature_flags = described_class.list_organization_feature_flags(
+            organization_id: 'org_01HX7Q7R12H1JMAKN75SH2G529',
+            options: { after: 'after-id' },
+          )
+
+          expect(feature_flags.data.size).to eq(2)
+        end
+      end
+    end
+
+    context 'with the limit option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations/org_01HX7Q7R12H1JMAKN75SH2G529/feature-flags?limit=10&'\
+          'order=desc',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list_organization_feature_flags', match_requests_on: [:path] do
+          feature_flags = described_class.list_organization_feature_flags(
+            organization_id: 'org_01HX7Q7R12H1JMAKN75SH2G529',
+            options: { limit: 10 },
+          )
+
+          expect(feature_flags.data.size).to eq(2)
+        end
+      end
+    end
+
+    context 'with multiple pagination options' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations/org_01HX7Q7R12H1JMAKN75SH2G529/feature-flags?after=after-id&'\
+          'limit=5&order=asc',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list_organization_feature_flags', match_requests_on: [:path] do
+          feature_flags = described_class.list_organization_feature_flags(
+            organization_id: 'org_01HX7Q7R12H1JMAKN75SH2G529',
+            options: { after: 'after-id', limit: 5, order: 'asc' },
+          )
+
+          expect(feature_flags.data.size).to eq(2)
+        end
+      end
+    end
+  end
 end

data/spec/lib/workos/user_management_spec.rb

@@ -202,6 +202,41 @@ describe WorkOS::UserManagement do
       end
     end
 
+    context 'with a screen hint' do
+      let(:args) do
+        {
+          provider: 'authkit',
+          screen_hint: 'sign_up',
+          client_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          }.to_s,
+        }
+      end
+      it 'returns a valid URL' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url)).to be_a URI
+      end
+
+      it 'returns the expected hostname' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
+      end
+
+      it 'returns the expected query string' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url).query).to eq(
+          'client_id=workos-proj-123&redirect_uri=foo.com%2Fauth%2Fcallback' \
+          '&response_type=code&state=%7B%3Anext_page%3D%3E%22%2Fdashboard%2F' \
+          'edit%22%7D&screen_hint=sign_up&provider=authkit',
+        )
+      end
+    end
+
     context 'with neither connection_id, organization_id or provider' do
       let(:args) do
         {

data/spec/support/fixtures/vcr_cassettes/organization/list_organization_feature_flags.yml

@@ -0,0 +1,78 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/organizations/org_01HX7Q7R12H1JMAKN75SH2G529/feature-flags?order=desc
+    body:
+      encoding: US-ASCII
+      string: ''
+    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.1.4; arm64-darwin24; v5.24.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 04 Aug 2025 18:37:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 96a029f4191e2f57-LAX
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"1f7-g5rU0vT2OhGT9sAPsywR3YS8ePw"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      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:
+      - 9cd52998-5106-40cf-9080-82c07528c672
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - _cfuvid=_9dbE_0fDVZ45WXvgEp8frEFOIlVDyARPbMk3AffOcs-1754332624329-0.0.1.1-604800000;
+        path=/; domain=.workos.com; HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"list","data":[{"object":"feature_flag","id":"flag_01K1V04FV94RNDSN5GKSZVQMYN","slug":"new-sidebar-layout","name":"New
+        Sidebar Layout","description":"","created_at":"2025-08-04T16:55:15.557Z","updated_at":"2025-08-04T16:55:15.557Z"},{"object":"feature_flag","id":"flag_01K1V02KNS6WHYXKG0DWB87THK","slug":"dark-mode-toggle","name":"Dark
+        Mode Toggle","description":"","created_at":"2025-08-04T16:54:13.942Z","updated_at":"2025-08-04T16:54:13.942Z"}],"list_metadata":{"before":null,"after":null}}'
+  recorded_at: Mon, 04 Aug 2025 18:37:04 GMT
+recorded_with: VCR 6.3.1

data/workos.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.0.1'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'rubocop', '~> 1.71'
-  spec.add_development_dependency 'vcr', '~> 5.0.0'
+  spec.add_development_dependency 'vcr', '~> 6.0'
   spec.add_development_dependency 'webmock'
 
   spec.required_ruby_version = '>= 3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 5.23.0
+  version: 5.25.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: encryptor
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - lib/workos/event.rb
 - lib/workos/events.rb
 - lib/workos/factor.rb
+- lib/workos/feature_flag.rb
 - lib/workos/hash_provider.rb
 - lib/workos/impersonator.rb
 - lib/workos/invitation.rb
@@ -274,6 +275,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/organization/get.yml
 - spec/support/fixtures/vcr_cassettes/organization/get_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
+- spec/support/fixtures/vcr_cassettes/organization/list_organization_feature_flags.yml
 - spec/support/fixtures/vcr_cassettes/organization/list_organization_roles.yml
 - spec/support/fixtures/vcr_cassettes/organization/update.yml
 - spec/support/fixtures/vcr_cassettes/organization/update_with_external_id.yml
@@ -504,6 +506,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/organization/get.yml
 - spec/support/fixtures/vcr_cassettes/organization/get_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
+- spec/support/fixtures/vcr_cassettes/organization/list_organization_feature_flags.yml
 - spec/support/fixtures/vcr_cassettes/organization/list_organization_roles.yml
 - spec/support/fixtures/vcr_cassettes/organization/update.yml
 - spec/support/fixtures/vcr_cassettes/organization/update_with_external_id.yml