Skip to content

Releases: workos/workos-python

v8.0.0

26 May 19:55
ddd2e67

Choose a tag to compare

Bug Fixes

  • deps: update dependency cryptography to v48 (#659) (1ccc411)

  • #662 feat(generated)!: regenerate from spec (10 changes)

    ⚠️ Breaking

    • user_management: Remove organization membership methods, move to new service
      • Removed list_organization_memberships, create_organization_membership, get_organization_membership, update_organization_membership, delete_organization_membership, deactivate_organization_membership, and reactivate_organization_membership methods from UserManagement.
      • Removed RoleSingle and RoleMultiple dataclasses from UserManagement.
      • Organization membership management is now handled by the new OrganizationMembershipService.
      • Client accessor renamed from client.user_management_organization_membership_groups to client.organization_membership.
    • organization_membership: Add new OrganizationMembershipService with membership and group operations
      • Created new OrganizationMembershipService with list_organization_memberships, create_organization_membership, get_organization_membership, update_organization_membership, delete_organization_membership, deactivate_organization_membership, reactivate_organization_membership, and list_organization_membership_groups methods.
      • Added RoleSingle and RoleMultiple dataclasses to support role assignment.
      • Added AsyncOrganizationMembershipService for async operations.
    • vault: Replace hand-maintained Vault module with generated Vault service
      • The old workos.vault module (vault.py) has been replaced by a generated vault/_resource.py service. Method renames:
        • read_objectget_kv
        • read_object_by_nameget_name
        • get_object_metadata → removed (no direct equivalent)
        • list_objectslist_kv
        • list_object_versionslist_kv_versions
        • create_objectcreate_kv
        • update_objectupdate_kv
        • delete_objectdelete_kv
        • create_data_key(key_context=...)create_data_key(context=...)
        • decrypt_data_keycreate_decrypt
      • Removed types: DataKey, DataKeyPair, ObjectDigest, ObjectUpdateBy. Replaced by new generated models (CreateDataKeyResponse, DecryptResponse, ObjectMetadata, ObjectSummary, ObjectWithoutValue, VaultObject, etc.).
      • Added new methods: create_rekey, list_kv_metadata.
      • Added AsyncVault for async operations.
      • Client-side encrypt/decrypt (AES-GCM) methods are preserved with the same signatures.
    • connect: ConnectApplication is now a discriminated union
      • ConnectApplication was a single dataclass; it is now a discriminated union dispatcher based on application_type.
      • All Connect methods (list_applications, create_application, get_application, update_application) now return ConnectApplicationVariant (a union of ConnectApplicationM2M, ConnectApplicationOAuth, or ConnectApplicationUnknown).
      • Code using isinstance(x, ConnectApplication) or accessing type-specific fields without checking the variant will need updating.
    • radar: Remove device_fingerprint and bot_score parameters from assess request
      • Removed device_fingerprint and bot_score optional parameters from Radar.create_attempt and AsyncRadar.create_attempt methods.
      • Removed these fields from RadarStandaloneAssessRequest model.
    • radar: Rename radar list/action enums and remove enum values
      • Renamed RadarAction to RadarListAction and RadarType to RadarListType (affects add_list_entry and remove_list_entry method signatures).
      • RadarStandaloneResponseBlocklistType is now a lazy re-export alias of RadarListType.
      • Removed credential_stuffing and ip_sign_up_rate_limit values from RadarStandaloneResponseControl enum.
      • Removed login, signup, sign_up, and sign_in values from RadarStandaloneAssessRequestAction enum; only sign-up and sign-in remain.
    • authorization: Remove search parameter and add resource/role filtering
      • Removed search parameter from Authorization.list_resources and AsyncAuthorization.list_resources.
      • Added resource_id, resource_external_id, resource_type_slug parameters to list_role_assignments method.
      • Added role_slug parameter to list_role_assignments_for_resource_by_external_id and list_role_assignments_for_resource methods.
    • api_keys: Add expires_at field to API key models
      • Added expires_at optional field to CreateOrganizationApiKey model.
      • Added expires_at optional field to CreateUserApiKey model.
      • Added expires_at to organizational and user API key models (OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue).
      • Added expires_at parameter to create_organization_api_key and create_user_api_key methods.
    • audit_logs: Rename audit log models and update service references
      • Renamed AuditLogActionJson to AuditLogAction.
      • Renamed AuditLogExportJson to AuditLogExport.
      • Renamed AuditLogSchemaJson to AuditLogSchema.
      • Renamed AuditLogSchemaJsonActor to AuditLogSchemaActorInput and AuditLogSchemaJsonTarget to AuditLogSchemaTargetInput.
      • Added new AuditLogSchemaInput model (used for schema creation payloads).
      • Renamed AuditLogsRetentionJson to AuditLogsRetention.
      • Updated all service methods to use new model names.
    • webhooks: Rename WebhookEndpointJson to WebhookEndpoint
      • Renamed WebhookEndpointJson model to WebhookEndpoint.
      • Updated all service methods to use the new model name.
      • Updated webhook endpoint status references.

    Features

    • common: Add new models for pipes events and enhancements
      • Added Actor model representing the user or API key that performed an action.
      • Added Error model for error response bodies.
      • Added PipeConnectedAccount model with state enumeration.
      • Added pipe event models: PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded.
      • Added webhook event enum values for pipes connected account events.
      • Renamed AuditLogExportJsonState to AuditLogExportState.
      • Renamed WebhookEndpointJsonStatus to WebhookEndpointStatus.
      • Updated UserManagementAuthenticationScreenHint to use RadarStandaloneAssessRequestAction type alias.

v7.0.1

11 May 16:52
9222b93

Choose a tag to compare

7.0.1 (2026-05-11)

Bug Fixes

  • Harden webhook, vault, session, and base client paths (#654) (d21f3b4)

v7.0.0

07 May 00:06
25307bf

Choose a tag to compare

7.0.0 (2026-05-07)

⚠ BREAKING CHANGES

  • api_keys: Restructure API key models for dual ownership
  • common: Add user API key event models and refactor BYOK key provider
  • authorization: Refactor role assignment models and add list endpoints

Features

  • api_keys: Restructure API key models for dual ownership (8b5e91d)
  • authorization: Refactor role assignment models and add list endpoints (8b5e91d)
  • common: Add user API key event models and refactor BYOK key provider (8b5e91d)
  • docs: Publish pdoc-generated API reference to GitHub Pages (#651) (05831ea)
  • user_management: Add user API key management endpoints (8b5e91d)

Bug Fixes

  • generated: Remove service-specific pagination order enums across SDK (8b5e91d)

v6.2.0

01 May 17:35
af9e88d

Choose a tag to compare

6.2.0 (2026-05-01)

Features

  • add get_jwks_url helper to UserManagement (#644) (53134d3)
  • generated: use explicit re-export form in service init.py (#645) (7ecb2e9)

Bug Fixes

  • set canonical User-Agent header format (#643) (f9cf9a1)

v6.1.0

28 Apr 16:36
788af10

Choose a tag to compare

6.1.0 (2026-04-28)

Features

  • generated: Add Groups API and Waitlist User events support (#640) (a10d02b)

Bug Fixes

  • Install ruff globally in setup script for code generation (b12b1d3)

v6.0.8

24 Apr 18:42
9ac84ce

Choose a tag to compare

6.0.8 (2026-04-24)

Bug Fixes

  • list Slack as an auth provider for the authorization URL (#633) (87fc5ab)

v6.0.7

23 Apr 15:40
6fdc448

Choose a tag to compare

6.0.7 (2026-04-23)

Bug Fixes

  • export missing types and update event tests (#631) (0bd6cf8)

This PR was generated with Release Please. See documentation.

v6.0.6

22 Apr 22:32
f35fb92

Choose a tag to compare

6.0.6 (2026-04-22)

Bug Fixes

  • restore typed EventSchema discriminated union dispatcher (#629) (af95901)

v6.0.5

20 Apr 20:58
aaa34fe

Choose a tag to compare

6.0.5 (2026-04-20)

Bug Fixes

v6.0.4

16 Apr 03:09
8441818

Choose a tag to compare

6.0.4 (2026-04-16)

Bug Fixes

  • add documentation on sealing sessions (#625) (5ae90d0)
  • Remove extractVersion from matchUpdateTypes rules (#623) (09a2e5d)