WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Python SDK

github.com
workos/workos-python
41 Stars
11 Forks
31 Contributors
github.com
Official Python SDK for interacting with the WorkOS API.

Installation

Command Line
Python

Beta Versions

Certain WorkOS features may be available only in the beta version of the SDK. Beta versions have the -beta.* suffix, for example, 3.2.0-beta.1. For more information on how to use the beta versions, refer to the README in the GitHub repository.

Releases

July 23, 2024

v4.13.0

Latest
July 23, 2024

Added

  • Support for Apple OAuth (https://github.com/workos/workos-python/pull/277)
June 20, 2024

v4.12.0

June 20, 2024

Added

  • Support for lookup_key. Contact support@workos.com for more information (#278)

Deprecated

  • Marked the allow_profiles_outside_organization Organization option as deprecated (#279)
June 12, 2024

v4.11.0

June 12, 2024
  • Add PKCE parameters to User Management authentication methods
June 4, 2024

v4.10.0

June 4, 2024

Added

  • Added support for totp_secret on user_management. enroll_auth_factor (#273)
  • Introduced user_management.find_invitation_by_token method (#274)
May 28, 2024

v4.9.0

May 28, 2024

Added

  • Added role to Directory User (https://github.com/workos/workos-python/pull/267)
May 24, 2024

v4.8.0

May 24, 2024

Added

  • Added inviter_user_id to invitation object returned by API (#268)
  • Added new endpoints to the User Management API to support sending your own emails: get_email_verification, get_password_reset, and create_password_reset (#268)
  • Deprecation notice for the send_password_reset_email method in favor of create_password_reset (#268)

Fixed

  • Fixed bug with trailing forward slash in JWKS and logout URLs (#270)
May 17, 2024

v4.7.0

May 17, 2024

What's Changed

  • Add JWKS and logout methods by @PaulAsjes in https://github.com/workos/workos-python/pull/265
  • Add organization membership deactivate and reactivate API methods by @mattgd in https://github.com/workos/workos-python/pull/264

New Contributors

  • @PaulAsjes made their first contribution in https://github.com/workos/workos-python/pull/265

Full Changelog: https://github.com/workos/workos-python/compare/v4.6.0...v4.7.0

May 3, 2024

v4.6.0

May 3, 2024

Added

  • Added accept_invitation_url to invitation object returned by API (#262)
  • Added new endpoints to the Magic Auth API: get_magic_auth and create_magic_auth (#262)
  • Deprecation notice for the send_magic_auth_code method in favor of create_magic_auth (#262)
May 1, 2024

v4.5.0

May 1, 2024

Added

  • Add domain_data to Organizations Create and Update methods to replace the now deprecated domains parameter (#257)
April 29, 2024

v4.4.0

April 29, 2024

What's Changed

  • Allow passing in organization_id into the Events API as a parameter https://github.com/workos/workos-python/pull/259
April 10, 2024

v4.3.1

April 10, 2024

What's Changed

  • Fix string interpolation when building MFA URLs in https://github.com/workos/workos-python/pull/254

Full Changelog: https://github.com/workos/workos-python/compare/v4.3.0...v4.3.1

April 8, 2024

v4.3.0

April 8, 2024

Added

  • Added optional role_slug parameter to send invitation payload to specify a user's organization membership role when inviting (#243)
  • Added password_hash and password_hash_type to User creation (#249)
April 3, 2024

v4.2.0

April 3, 2024
  • Added configurable request timeout
April 2, 2024

v4.1.0

April 2, 2024

Added

  • Added session management api (#245)
March 21, 2024

v4.0.0

March 21, 2024

Added

  • Added impersonator data to User Management authentication responses (#237)

Removed

  • Removed lingering Python 2-related dependencies (#235)
March 18, 2024

v3.1.0

March 18, 2024

Added

  • Role parameter to User Management OrganizationMembership API, and new PUT endpoint for User Management OrganizationMembership API (https://github.com/workos/workos-python/pull/236)
March 8, 2024

v3.0.0

March 8, 2024

Changed

  • Changed all resource list methods to default to descending order (#234)

Addded

  • Added status to organization membership (#233)

Removed

  • Removed support for Python v2.x. Python v3.7 and newer is supported

Full Changelog: https://github.com/workos/workos-python/compare/v2.2.0...v3.0.0

February 7, 2024

v2.2.0

February 7, 2024

Added

  • Add profile_picture_url to the user object by @hadihallak in https://github.com/workos/workos-python/pull/231

Full Changelog: https://github.com/workos/workos-python/compare/v2.1.0...v2.2.0

December 14, 2023

v2.1.0

December 14, 2023

Added

  • Added GitHubOAuth as a provider (#228)

Full Changelog: https://github.com/workos/workos-python/compare/v2.0.0...v2.1.0

December 8, 2023

v2.0.0

December 8, 2023

Added

  • Stable release of User Management API: https://workos.com/docs/user-management

Changed

  • [Breaking change] sso.get_authorization_url method only accepts SsoProviderType enum for the provider parameter (#224)

Removed

  • [Breaking change] Removed deprecated Audit Trail package (#219)

Full Changelog: https://github.com/workos/workos-python/compare/v1.26.0...v2.0.0

August 11, 2023

v1.27.0

August 11, 2023

Added

  • Add expires_in parameter to create_session.

Changed

  • Removed connections parameter from create_session.
June 26, 2023

v1.26.0

June 26, 2023

Changed

  • Changed the Events API (in beta) rangeStart and rangeEnd parameters to range_start and range_end(https://github.com/workos/workos-python/pull/184).
June 16, 2023

v1.25.0

June 16, 2023

Changed

  • GetEvents is now ListEvents in the Events API Beta
May 24, 2023

v1.24.0

May 24, 2023

Added

  • Adds support for Events beta API
May 11, 2023

v1.23.3

May 11, 2023
  • Pins dependency versions for deployment
May 11, 2023

v1.23.2

May 11, 2023
  • Updates internal CI configuration
May 10, 2023

v1.23.1

May 10, 2023
  • Fixes issue with default limit check in SSO, Directory Sync, and Organizations list methods
April 26, 2023

v1.23.0

April 26, 2023
  • Add auto_pagination_iter method to list endpoints
  • Add *_v2 version of list methods to allow auto_pagination_iter to be called directly
March 9, 2023

v1.22.0

March 9, 2023

Added

  • Added groups attribute to SSO user profile. This feature is in beta, please reach out to support@workos.com to access this feature. (#170)
December 8, 2022

v1.21.0

December 8, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-python/pull/166)