Installation

Command Line
cURL

Releases

v1.17.0

September 26, 2022
September 26, 2022
  • Add support for idempotency-key on Create Organization method
  • Add support for primary_email method on WorkOSDirectoryUser class

v1.16.0

September 16, 2022
September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#148)

v1.15.1

September 15, 2022
September 15, 2022

Fixed

  • Fix Audit Logs Exports calls (https://github.com/workos/workos-python/pull/146)

v1.15.0

August 25, 2022
August 25, 2022

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)

v1.14.1

August 22, 2022
August 22, 2022

Updated

  • Fixed provider validation for OAuth connections

v1.14.0

July 20, 2022
July 20, 2022

Added

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

v1.13.0

July 15, 2022
July 15, 2022

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)

v1.12.0

June 7, 2022
June 7, 2022

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)

v1.11.0

March 30, 2022
March 30, 2022

Added

  • Added support for MFA API (#116)

v1.10.0

March 9, 2022
March 9, 2022

Added

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

v1.9.0

February 28, 2022
February 28, 2022

Added

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

v1.8.0

February 24, 2022
February 24, 2022

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)

v1.7.0

December 16, 2021
December 16, 2021

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)

v1.6.0

December 16, 2021
December 16, 2021

Added

  • Added method to get single directory (#99)

v1.5.1

November 2, 2021
November 2, 2021

Fixed

  • Fixed webhooks method routing bug (#98)

v1.5.0

November 1, 2021
November 1, 2021

Added

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

v1.4.1

October 19, 2021
October 19, 2021

Fixed

  • Fixed error handling bug (#95)

v1.4.0

September 23, 2021
September 23, 2021

Added

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

v1.3.1

September 15, 2021
September 15, 2021

Fixed

  • Fixed bug with JSON response handling (#87)

v1.3.0

September 14, 2021
September 14, 2021

Added

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

Updated

  • Improved JSON Parsing (#84)

v1.2.0

May 28, 2021
May 28, 2021

Added

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

Updated

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

v1.1.0

May 15, 2021
May 15, 2021

Added

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

v1.0.0

May 12, 2021
May 12, 2021

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_organizationsorganizations.list_organizations
    • portal.create_organizationorganizations.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)

v0.8.7

April 8, 2021
April 8, 2021

Added

  • Added connection to get_authorization_url (#61)

v0.8.5

February 23, 2021
February 23, 2021

Updated

  • Implemented __str__ for BaseRequestException (#57)

v0.8.4

February 17, 2021
February 17, 2021

Fixed

  • Fixed bug with use of client_id (#56)

v0.8.3

February 2, 2021
February 2, 2021

Added

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

v0.8.2

November 17, 2020
November 17, 2020

Updated

  • Updated available Connection Types (#46)

v0.8.1

October 21, 2020
October 21, 2020

Added

  • Added passwordless property to client (#44)

v0.8.0

October 14, 2020
October 14, 2020

Updated

  • Exposed connection_id attribute on Profile objects (#43)