Summary
A developer integrating user provisioning reported that the Node SDK's externalId-based user methods were not discoverable: createUserAndMembership() / updateUser() accepted an externalId in their typed options but silently dropped it, and there was no documented way to look a user up by external ID. The SDK fix shipped in @scalekit-sdk/node 2.6.2, which now exposes getUserByExternalId, updateUserByExternalId, and deleteUserByExternalId. The documentation has not caught up.
Why this matters
externalId is the documented mechanism for cross-system user correlation. Without docs for the external-ID methods, developers fall back to ID-only lookups or assume the capability is missing, and silent drops lead to records persisted with an empty external_id.
Proposed work
Source
Surfaced through developer support during implementation work. The SDK code fix is already released; this issue tracks the documentation follow-up.
Summary
A developer integrating user provisioning reported that the Node SDK's
externalId-based user methods were not discoverable:createUserAndMembership()/updateUser()accepted anexternalIdin their typed options but silently dropped it, and there was no documented way to look a user up by external ID. The SDK fix shipped in@scalekit-sdk/node2.6.2, which now exposesgetUserByExternalId,updateUserByExternalId, anddeleteUserByExternalId. The documentation has not caught up.Why this matters
externalIdis the documented mechanism for cross-system user correlation. Without docs for the external-ID methods, developers fall back to ID-only lookups or assume the capability is missing, and silent drops lead to records persisted with an emptyexternal_id.Proposed work
externalId-based user methods (getUserByExternalId,updateUserByExternalId,deleteUserByExternalId) in the user-management reference and relevant guides.external_idwithin an organization (does a duplicate conflict, or are duplicates allowed?).externalIdmust be forwarded on create/update so it is not silently ignored.Source
Surfaced through developer support during implementation work. The SDK code fix is already released; this issue tracks the documentation follow-up.