Python SDK

Added

• Added support for Audit Logs endpoints (#139):
  • audit_logs.create_event()
  • audit_logs.create_export()
  • audit_logs.get_export()
• Added WorkOS classes for WorkOSAuditLogExport (#139)

Changed

• Changed the client User Agent to also send the Python version (#140)

Updated

• Fixed provider validation for OAuth connections

Added

• Added support for GET /Directory endpoint (#135)
• Added WorkOS classes for WorkOSConnection, WorkOSDirectory, WorkOSUser, WorkOSOrganization, WorkOSAuthenticationFactor, WorkOSChallengeVerification, and WorkOSPasswordlessSession (#135)

Added

• Added support for updating allow_profiles_outside_organization with update_organization (#128)

Changed

• Updated endpoints used for MFA operations (#131)

Fixed

• Fixed is with a string literal warning (#133)

Deprecated

• The verify_factor attribute has been deprecated in factor of verify_challenge (#131)

Added

• Added order parameter to pagination SDK (#124)

Updated

• Updated MFA Challenge response object as a defined class (#126)
• Updated Directory Sync Directory Group response object as a defined class (#125)
• Updated Connection Type enum list to include all supported providers (#125)

Added

• Added support for MFA API (#116)

Added

• Added more values to the ConnectionType enum (#117)

Added

• Added organization parameter to the List Organizations endpoint for Directory Sync. This allows filtering of the directories returned by organization ID (#114)

Changed

• The get_authorization_url attribute now throws an exception when redirect_uri is not provided (#107)
  • This matches the upstream requirements of the WorkOS API
• The list_connections attribute now accepts a ConnectionType for the connection_type parameter (#112)
  • String values will continue to work, but are considered deprecated

Deprecated

• Deprecated passing string values as the connection_type parameter for list_connections (#112)

Added

• Support for domain_hint and login_hint parameters to get_authorization_url (#105)
• Support for organization parameter to get_authorization_url (#104)

Deprecated

• Deprecated the domain parameter for get_authorization_url in favor of organization (#104)

Added

• Added method to get single directory (#99)

Fixed

• Fixed webhooks method routing bug (#98)

Added

• Added webhook signature and timestamp validation method (#92)

Fixed

• Fixed error handling bug (#95)

Added

• Documented support for allow_profiles_outside_organization to organizations (#89)
• Added organization_id to profiles (#90)

Fixed

• Fixed bug with JSON response handling (#87)

Added

• Added get_profile function (#83)
• Added Microsoft OAuth as a provider (#85)

Updated

• Improved JSON Parsing (#84)

Added

• Added organizations.update_organization (#76)
• Added organizations.delete_organization (#77)

Updated

• Updated Development Status to Production/Stable (#75)

Added

• Added organizations property to Client (#73)
• Added organizations.get_organization (#72)
• Added directory_sync.delete_directory (#65)

Breaking Changes

• sso.get_profile has been renamed to sso.get_profile_and_token (#67)
  • The return type has also been changed from Profile to ProfileAndToken
• Organization operations have been moved from the portal namespace to organizations (#68)
  • portal.list_organizations → organizations.list_organizations
  • portal.create_organization → organizations.create_organization
• sso.create_connection and sso.promote_draft_connection have been removed (#69)

Removed Deprecations

• The deprecated project_id parameter has been fully removed. The client_id parameter should be used instead (#66)

Added

• Added connection to get_authorization_url (#61)

Updated

• Implemented __str__ for BaseRequestException (#57)

Fixed

• Fixed bug with use of client_id (#56)

Added

• Added GET /connections (#51)
• Added GET /connections/:id (#52)
• Added DELETE /connections/:id (#53)

Updated

• Updated available Connection Types (#46)

Added

• Added passwordless property to client (#44)

Updated

• Exposed connection_id attribute on Profile objects (#43)

Added

• Added MagicLink support through Passwordless module (#41)

Added

• Added generate_link function to Portal module (#39)
• Added create_organization function to Portal module (#38)
• Added Portal module with list_organizations function (#37)

Updated

• Exposed raw_attributes on WorkOSProfile (#36)