feat: Add signalsId to user management APIs#1618
Conversation
Add optional signalsId field to all user management methods that interact with Radar-enabled endpoints: - createUser - authenticateWithCode - authenticateWithCodeAndVerifier - authenticateWithPassword - authenticateWithMagicAuth - createMagicAuth Each method's options interface, serialized interface, and serializer are updated to map signalsId to signals_id in the request body. Tests added for each method. Co-Authored-By: blair <blair@workos.com>
Original prompt from blair
|
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Greptile SummaryAdds an optional
Confidence Score: 5/5All additions are optional fields with no breaking changes; existing callers are unaffected. The change is a straightforward, additive expansion of six parallel interfaces and serializers. Every updated method follows the same three-part pattern applied identically, each has a corresponding test, and no existing logic is modified. No files require special attention. Important Files Changed
|
Description
Adds optional
signalsIdfield to all user management methods that interact with Radar-enabled endpoints, matching the backend support added in workos/workos#62383 (RDR-765).Methods updated:
createUser—POST /user_management/usersauthenticateWithCode—POST /user_management/authenticate(authorization_codegrant, confidential client)authenticateWithCodeAndVerifier—POST /user_management/authenticate(authorization_codegrant, public client / PKCE)authenticateWithPassword—POST /user_management/authenticate(passwordgrant)authenticateWithMagicAuth—POST /user_management/authenticate(magic-auth:codegrant)createMagicAuth—POST /user_management/magic_authPer method, three changes:
signalsId?: stringsignals_id?: stringsignalsId → signals_idAll additions are optional and fully backwards compatible. Tests added for each method verifying
signals_idis sent in the request body.Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
API reference should document the new
signals_idparameter on the affected endpoints.Link to Devin session: https://app.devin.ai/sessions/f934ecaac1d84be6bc6713eaa76ba57b
Requested by: @blairworkos