-beta.* suffix, for example,
3.2.0-beta.1. For more information on how to use beta
versions, refer to the README in the GitHub repository.
⚠️ Breaking
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.RoleSingle and RoleMultiple dataclasses from UserManagement.OrganizationMembershipService.client.user_management_organization_membership_groups to client.organization_membership.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.RoleSingle and RoleMultiple dataclasses to support role assignment.AsyncOrganizationMembershipService for async operations.workos.vault module (vault.py) has been replaced by a generated vault/_resource.py service. 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_decryptDataKey, DataKeyPair, ObjectDigest, ObjectUpdateBy. Replaced by new generated models (CreateDataKeyResponse, DecryptResponse, ObjectMetadata, ObjectSummary, ObjectWithoutValue, VaultObject, etc.).create_rekey, list_kv_metadata.AsyncVault for async operations.encrypt/decrypt (AES-GCM) methods are preserved with the same signatures.ConnectApplication is now a discriminated unionConnectApplication was a single dataclass; it is now a discriminated union dispatcher based on application_type.list_applications, create_application, get_application, update_application) now return ConnectApplicationVariant (a union of ConnectApplicationM2M, ConnectApplicationOAuth, or ConnectApplicationUnknown).isinstance(x, ConnectApplication) or accessing type-specific fields without checking the variant will need updating.device_fingerprint and bot_score optional parameters from Radar.create_attempt and AsyncRadar.create_attempt methods.RadarStandaloneAssessRequest model.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.credential_stuffing and ip_sign_up_rate_limit values from RadarStandaloneResponseControl enum.login, signup, sign_up, and sign_in values from RadarStandaloneAssessRequestAction enum; only sign-up and sign-in remain.search parameter from Authorization.list_resources and AsyncAuthorization.list_resources.resource_id, resource_external_id, resource_type_slug parameters to list_role_assignments method.role_slug parameter to list_role_assignments_for_resource_by_external_id and list_role_assignments_for_resource methods.expires_at optional field to CreateOrganizationApiKey model.expires_at optional field to CreateUserApiKey model.expires_at to organizational and user API key models (OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue).expires_at parameter to create_organization_api_key and create_user_api_key methods.AuditLogActionJson to AuditLogAction.AuditLogExportJson to AuditLogExport.AuditLogSchemaJson to AuditLogSchema.AuditLogSchemaJsonActor to AuditLogSchemaActorInput and AuditLogSchemaJsonTarget to AuditLogSchemaTargetInput.AuditLogSchemaInput model (used for schema creation payloads).AuditLogsRetentionJson to AuditLogsRetention.WebhookEndpointJson model to WebhookEndpoint.Features
Actor model representing the user or API key that performed an action.Error model for error response bodies.PipeConnectedAccount model with state enumeration.PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded.AuditLogExportJsonState to AuditLogExportState.WebhookEndpointJsonStatus to WebhookEndpointStatus.UserManagementAuthenticationScreenHint to use RadarStandaloneAssessRequestAction type alias.get_jwks_url helper to UserManagement (https://github.com/workos/workos-python/issues/644" rel="noreferrer" target="_blank">#644) (https://github.com/workos/workos-python/commit/53134d32f168dd0da606672125e8cdd221832761" rel="noreferrer" target="_blank">53134d3)--- This PR was generated with Release Please. See documentation.
EventSchema discriminated union dispatcher (https://github.com/workos/workos-python/issues/629" rel="noreferrer" target="_blank">#629) (https://github.com/workos/workos-python/commit/af95901ed8e607622795a19b15c4a7bf88eca4f7" rel="noreferrer" target="_blank">af95901)workos.client.portal has been renamed to client.admin_portal, and client.fga is not available in v6.See the [V6 migration guide](docs/V6_MIGRATION_GUIDE.md) before upgrading from v5.
Full Changelog: v5.42.0...v5.42.1
Full Changelog: v5.41.0...v5.42.0
Full Changelog: v5.40.1...v5.41.0
accepted_user_id to invitation by @gjtorikian in #525Full Changelog: v5.40.0...v5.40.1
Full Changelog: v5.39.1...v5.40.0
Full Changelog: v5.39.0...5.39.1
read_object_by_name method for Vault API by @hexedpackets in #506list_groups and list_users by @gjtorikian in #512Full Changelog: v5.37.0...v5.39.0
list_groups and list_users by @gjtorikian in #512Full Changelog: v5.38.0...v5.38.1
read_object_by_name method for Vault API by @hexedpackets in #506Full Changelog: v5.37.0...v5.38.0
Full Changelog: v5.36.0...v5.37.0
Full Changelog: v5.35.0...v5.36.0
Full Changelog: v5.34.1...v5.35.0