Repository navigation
fix(user-management): Expose nested user on OrganizationMembership - #1732
Open
gjtorikian wants to merge 1 commit into
Open
gjtorikian wants to merge 1 commit into
gjtorikian wants to merge 1 commit into
Conversation
The Organization Membership endpoints return a nested `user` object (the OpenAPI spec lists it as required on `UserlandUserOrganizationMembership`), but `deserializeOrganizationMembership` dropped it. Consumers iterating memberships had to make a separate `getUser` call per membership just to reach `user.email` or `user.externalId`. Add `user?: User` to `OrganizationMembership` (and `user?: UserResponse` to the response type) and deserialize it with `deserializeUser` when present. It stays optional because the same deserializer handles `organization_membership.*` event payloads and action contexts, which do not include the nested user. Fixes #1608
Contributor
[Medium impact] The PR appears safe to merge. SummaryExposes the nested
No actionable issues found. Tests were inspected but not run. Reviews (1) · Last reviewed commit: "fix(user-management): Expose nested user..." · Reviewed by Greptile |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
GET /user_management/organization_memberships(and the single get, create, update, deactivate and reactivate endpoints) return a nesteduserobject; the OpenAPI spec listsuseras required onUserlandUserOrganizationMembership. The SDK'sdeserializeOrganizationMembershipdropped it, so consumers had to make a separategetUsercall per membership to reachuser.emailoruser.externalId.user?: UsertoOrganizationMembershipanduser?: UserResponsetoOrganizationMembershipResponse.deserializeUserwhen present.useris optional rather than required because the same deserializer handlesorganization_membership.*event payloads and action contexts, which the spec defines without a nested user. Additive and non-breaking for existing consumers.Fixes #1608
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.