feat: Support screen_hint in user_management.get_authorization_url

Author: faroceann

tests/test_user_management.py

@@ -320,6 +320,29 @@ def test_authorization_url_has_expected_query_params_with_code_challenge(self):
             "response_type": RESPONSE_TYPE_CODE,
         }
 
+    def test_authorization_url_has_expected_query_params_with_screen_hint(self):
+        connection_id = "connection_123"
+        redirect_uri = "https://localhost/auth/callback"
+        screen_hint = "sign-up"
+
+        authorization_url = self.user_management.get_authorization_url(
+            connection_id=connection_id,
+            screen_hint=screen_hint,
+            redirect_uri=redirect_uri,
+            provider="authkit"
+        )
+
+        parsed_url = urlparse(authorization_url)
+        assert parsed_url.path == "/user_management/authorize"
+        assert dict(parse_qsl(str(parsed_url.query))) == {
+            "screen_hint": screen_hint,
+            "client_id": self.http_client.client_id,
+            "redirect_uri": redirect_uri,
+            "connection_id": connection_id,
+            "response_type": RESPONSE_TYPE_CODE,
+            "provider": "authkit"
+        }
+
     def test_get_jwks_url(self):
         expected = "%ssso/jwks/%s" % (
             self.http_client.base_url,

workos/types/user_management/screen_hint.py

@@ -0,0 +1,5 @@
+from typing import Literal
+
+ScreenHintType = Literal[
+    "sign-up", "sign-in"
+]

workos/user_management.py

@@ -48,6 +48,9 @@
 from workos.types.user_management.user_management_provider_type import (
     UserManagementProviderType,
 )
+from workos.types.user_management.screen_hint import (
+    ScreenHintType
+)
 from workos.typing.sync_or_async import SyncOrAsync
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.pagination_order import PaginationOrder
@@ -342,6 +345,7 @@ def get_authorization_url(
         organization_id: Optional[str] = None,
         code_challenge: Optional[str] = None,
         prompt: Optional[str] = None,
+        screen_hint: Optional[ScreenHintType] = None,
     ) -> str:
         """Generate an OAuth 2.0 authorization URL.
 
@@ -369,6 +373,7 @@ def get_authorization_url(
             prompt (str): Used to specify whether the upstream provider should prompt the user for credentials or other
                 consent. Valid values depend on the provider. Currently only applies to provider values of 'GoogleOAuth',
                 'MicrosoftOAuth', or 'GitHubOAuth'. (Optional)
+            screen_hint (ScreenHintType): Specify which AuthKit screen users should land on upon redirection (Only applicable when provider is 'authkit').
 
         Returns:
             str: URL to redirect a User to to begin the OAuth workflow with WorkOS
@@ -401,6 +406,8 @@ def get_authorization_url(
             params["code_challenge_method"] = "S256"
         if prompt is not None:
             params["prompt"] = prompt
+        if screen_hint is not None:
+            params["screen_hint"] = screen_hint
 
         return RequestHelper.build_url_with_query_params(
             base_url=self._client_configuration.base_url,