Add custom_attributes field to OrganizationMembership

[ajworkos]

Summary

Adds custom_attributes field to OrganizationMembership model to expose custom attributes from identity providers.

Changes

• Added custom_attributes field to OrganizationMembership type/model
• Field type: Record/Map/Dictionary of string keys to any values
• Always present, defaults to empty object {}
• Updated fixtures and tests

API Field Details

The field will be present in:

• REST API responses
• Webhook events
• Events API responses

JSON field name: custom_attributes (snake_case)

[greptile-apps]

Greptile Overview

Greptile Summary

Added idp_attributes field to OrganizationMembership to expose IDP custom attributes (department, employee_id, etc.)

Key Changes

• Added idpAttributes: Record<string, unknown> to OrganizationMembership interface and idp_attributes to OrganizationMembershipResponse
• Updated deserializeOrganizationMembership serializer to map the new field from snake_case to camelCase
• Updated all three user-management test fixtures with empty idp_attributes objects
• Package lock changes are unrelated dependency maintenance (removed peer flags)

Missing Update

• The authentication-action-context.json fixture in src/actions also contains an organization_membership object but is missing the idp_attributes field, which will cause the deserializer to fail when processing this fixture

Confidence Score: 4/5

• Safe to merge after fixing the missing field in authentication-action-context.json fixture
• The changes are straightforward and well-implemented across interfaces, serializers, and fixtures. However, one fixture file was missed (authentication-action-context.json) which will cause deserialization to fail with the updated interface. This is a minor issue that's easy to fix.
• src/actions/fixtures/authentication-action-context.json needs the idp_attributes field added

Important Files Changed

Filename	Overview
src/user-management/interfaces/organization-membership.interface.ts	Added idpAttributes field to both OrganizationMembership and OrganizationMembershipResponse interfaces
src/user-management/serializers/organization-membership.serializer.ts	Updated serializer to map idp_attributes from API response to idpAttributes in client model
src/user-management/fixtures/organization-membership.json	Added empty idp_attributes object to test fixture

Sequence Diagram

sequenceDiagram
    participant Client
    participant SDK as WorkOS SDK
    participant API as WorkOS API
    participant IDP as Identity Provider

    Note over API,IDP: IDP provides custom attributes
    IDP->>API: User attributes (department, employee_id, etc.)
    API->>API: Store as customAttributes

    Client->>SDK: getOrganizationMembership(id)
    SDK->>API: GET /organization_memberships/:id
    API->>SDK: OrganizationMembershipResponse with idp_attributes
    SDK->>SDK: deserializeOrganizationMembership()
    SDK->>SDK: Map idp_attributes → idpAttributes
    SDK->>Client: OrganizationMembership with idpAttributes

    Client->>SDK: listOrganizationMemberships()
    SDK->>API: GET /organization_memberships
    API->>SDK: List with idp_attributes in each item
    SDK->>SDK: deserializeOrganizationMembership() for each
    SDK->>Client: Array with idpAttributes

    Note over API,Client: Also available in webhooks and events
    API->>Client: Webhook: organization_membership.created
    Note over Client: Contains idp_attributes field

Loading

[greptile-apps]

_{3 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

Additional Comments (1)

src/actions/fixtures/authentication-action-context.json
Missing idp_attributes field in organization_membership object

    "organization_membership": {
        "object": "organization_membership",
        "id": "01JATCNVYCHT1SZGENR4QTXKRK",
        "user_id": "01JATCHZVEC5EPANDPEZVM68Y9",
        "organization_id": "01JATCMZJY26PQ59XT9BNT0FNN",
        "role": {
            "slug": "member"
        },
        "status": "active",
        "idp_attributes": {},
        "created_at": "2024-10-22T17:12:50.746Z",
        "updated_at": "2024-10-22T17:12:50.746Z"
    }

Prompt To Fix With AI

This is a comment left during a code review.
Path: src/actions/fixtures/authentication-action-context.json
Line: 29:40

Comment:
Missing `idp_attributes` field in organization_membership object

```suggestion
    "organization_membership": {
        "object": "organization_membership",
        "id": "01JATCNVYCHT1SZGENR4QTXKRK",
        "user_id": "01JATCHZVEC5EPANDPEZVM68Y9",
        "organization_id": "01JATCMZJY26PQ59XT9BNT0FNN",
        "role": {
            "slug": "member"
        },
        "status": "active",
        "idp_attributes": {},
        "created_at": "2024-10-22T17:12:50.746Z",
        "updated_at": "2024-10-22T17:12:50.746Z"
    }
```

How can I resolve this? If you propose a fix, please make it concise.