Releases: workos/workos-python
Releases · workos/workos-python
v8.0.0
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, andreactivate_organization_membershipmethods from UserManagement. - Removed
RoleSingleandRoleMultipledataclasses from UserManagement. - Organization membership management is now handled by the new
OrganizationMembershipService. - Client accessor renamed from
client.user_management_organization_membership_groupstoclient.organization_membership.
- Removed
- organization_membership: Add new OrganizationMembershipService with membership and group operations
- Created new
OrganizationMembershipServicewithlist_organization_memberships,create_organization_membership,get_organization_membership,update_organization_membership,delete_organization_membership,deactivate_organization_membership,reactivate_organization_membership, andlist_organization_membership_groupsmethods. - Added
RoleSingleandRoleMultipledataclasses to support role assignment. - Added
AsyncOrganizationMembershipServicefor async operations.
- Created new
- vault: Replace hand-maintained Vault module with generated Vault service
- The old
workos.vaultmodule (vault.py) has been replaced by a generatedvault/_resource.pyservice. Method renames:read_object→get_kvread_object_by_name→get_nameget_object_metadata→ removed (no direct equivalent)list_objects→list_kvlist_object_versions→list_kv_versionscreate_object→create_kvupdate_object→update_kvdelete_object→delete_kvcreate_data_key(key_context=...)→create_data_key(context=...)decrypt_data_key→create_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
AsyncVaultfor async operations. - Client-side
encrypt/decrypt(AES-GCM) methods are preserved with the same signatures.
- The old
- connect:
ConnectApplicationis now a discriminated unionConnectApplicationwas a single dataclass; it is now a discriminated union dispatcher based onapplication_type.- All Connect methods (
list_applications,create_application,get_application,update_application) now returnConnectApplicationVariant(a union ofConnectApplicationM2M,ConnectApplicationOAuth, orConnectApplicationUnknown). - 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_fingerprintandbot_scoreoptional parameters fromRadar.create_attemptandAsyncRadar.create_attemptmethods. - Removed these fields from
RadarStandaloneAssessRequestmodel.
- Removed
- radar: Rename radar list/action enums and remove enum values
- Renamed
RadarActiontoRadarListActionandRadarTypetoRadarListType(affectsadd_list_entryandremove_list_entrymethod signatures). RadarStandaloneResponseBlocklistTypeis now a lazy re-export alias ofRadarListType.- Removed
credential_stuffingandip_sign_up_rate_limitvalues fromRadarStandaloneResponseControlenum. - Removed
login,signup,sign_up, andsign_invalues fromRadarStandaloneAssessRequestActionenum; onlysign-upandsign-inremain.
- Renamed
- authorization: Remove search parameter and add resource/role filtering
- Removed
searchparameter fromAuthorization.list_resourcesandAsyncAuthorization.list_resources. - Added
resource_id,resource_external_id,resource_type_slugparameters tolist_role_assignmentsmethod. - Added
role_slugparameter tolist_role_assignments_for_resource_by_external_idandlist_role_assignments_for_resourcemethods.
- Removed
- api_keys: Add expires_at field to API key models
- Added
expires_atoptional field toCreateOrganizationApiKeymodel. - Added
expires_atoptional field toCreateUserApiKeymodel. - Added
expires_atto organizational and user API key models (OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue). - Added
expires_atparameter tocreate_organization_api_keyandcreate_user_api_keymethods.
- Added
- audit_logs: Rename audit log models and update service references
- Renamed
AuditLogActionJsontoAuditLogAction. - Renamed
AuditLogExportJsontoAuditLogExport. - Renamed
AuditLogSchemaJsontoAuditLogSchema. - Renamed
AuditLogSchemaJsonActortoAuditLogSchemaActorInputandAuditLogSchemaJsonTargettoAuditLogSchemaTargetInput. - Added new
AuditLogSchemaInputmodel (used for schema creation payloads). - Renamed
AuditLogsRetentionJsontoAuditLogsRetention. - Updated all service methods to use new model names.
- Renamed
- webhooks: Rename WebhookEndpointJson to WebhookEndpoint
- Renamed
WebhookEndpointJsonmodel toWebhookEndpoint. - Updated all service methods to use the new model name.
- Updated webhook endpoint status references.
- Renamed
Features
- common: Add new models for pipes events and enhancements
- Added
Actormodel representing the user or API key that performed an action. - Added
Errormodel for error response bodies. - Added
PipeConnectedAccountmodel with state enumeration. - Added pipe event models:
PipesConnectedAccountConnected,PipesConnectedAccountDisconnected,PipesConnectedAccountReauthorizationNeeded. - Added webhook event enum values for pipes connected account events.
- Renamed
AuditLogExportJsonStatetoAuditLogExportState. - Renamed
WebhookEndpointJsonStatustoWebhookEndpointStatus. - Updated
UserManagementAuthenticationScreenHintto useRadarStandaloneAssessRequestActiontype alias.
- Added
- user_management: Remove organization membership methods, move to new service
v7.0.1
v7.0.0
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)