WorkOS Docs Homepage
SDKs
DashboardSign In
SDKs

Python SDK

github.com
workos/workos-python
32 Stars
10 Forks
28 Contributors
github.com
Official Python SDK for interacting with the WorkOS API.

Installation

Command Line
Python

Releases

v4.3.1

April 10, 2024
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

v4.3.0

April 8, 2024
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)

v4.2.0

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

v4.1.0

April 2, 2024
April 2, 2024

Added

  • Added session management api (#245)

v4.0.0

March 21, 2024
March 21, 2024

Added

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

Removed

  • Removed lingering Python 2-related dependencies (#235)

v3.1.0

March 18, 2024
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)

v3.0.0

March 8, 2024
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

v2.2.0

February 7, 2024
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

v2.1.0

December 14, 2023
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

v2.0.0

December 8, 2023
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

v1.27.0

August 11, 2023
August 11, 2023

Added

  • Add expires_in parameter to create_session.

Changed

  • Removed connections parameter from create_session.

v1.26.0

June 26, 2023
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).

v1.25.0

June 16, 2023
June 16, 2023

Changed

  • GetEvents is now ListEvents in the Events API Beta

v1.24.0

May 24, 2023
May 24, 2023

Added

  • Adds support for Events beta API

v1.23.3

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

v1.23.2

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

v1.23.1

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

v1.23.0

April 26, 2023
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

v1.22.0

March 9, 2023
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)

v1.21.0

December 8, 2022
December 8, 2022

Added

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

v1.20.2

November 8, 2022
November 8, 2022

Changed

  • Encoding of event body in the webhooks validation method (https://github.com/workos/workos-python/pull/161)

v1.20.1

October 24, 2022
October 24, 2022

Changed

  • Webhooks validation method error handling (https://github.com/workos/workos-python/pull/151)

v1.20.0

October 24, 2022
October 24, 2022

Added

  • Adds MFA delete_factor and get_factor methods (#152)

v1.19.0

October 18, 2022
October 18, 2022

Added

  • Add success_url (https://github.com/workos/workos-python/pull/156)

Changed

  • Correctly parse both string/enum based connection types (https://github.com/workos/workos-python/pull/155)

v1.18.0

October 12, 2022
October 12, 2022

Added

  • Added job title attribute for directory users (#153)

v1.17.0

September 26, 2022
September 26, 2022

Added

  • 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