WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Python SDK

github.com
workos/workos-python
53 Stars
17 Forks
43 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

June 2, 2025

v5.23.0

Latest
June 2, 2025

What's Changed

  • Added support for provider_scopes query param (https://github.com/workos/workos-python/pull/454)

Full Changelog: https://github.com/workos/workos-python/compare/v5.22.0...v5.23.0

May 22, 2025

v5.22.0

May 22, 2025

What's Changed

  • Add email as option to UserManagement.update_user (#452)
May 9, 2025

v5.21.0

May 9, 2025

What's Changed

  • Add warnings field to FGA check / query response by @atainter in https://github.com/workos/workos-python/pull/442
  • Bump to 5.21.0 by @atainter in https://github.com/workos/workos-python/pull/443

Full Changelog: https://github.com/workos/workos-python/compare/v5.20.2...v5.21.0

May 2, 2025

v5.20.2

May 2, 2025

What's Changed

  • Avoid decoding jwt twice by @na-ka-na in https://github.com/workos/workos-python/pull/440
  • Bump to v5.20.2 by @gcarvelli in https://github.com/workos/workos-python/pull/441

New Contributors

  • @na-ka-na made their first contribution in https://github.com/workos/workos-python/pull/440

Full Changelog: https://github.com/workos/workos-python/compare/v5.20.1...v5.20.2

May 1, 2025

v5.20.1

May 1, 2025

What's Changed

  • Convert context into query string for FGA queries by @stanleyphu in https://github.com/workos/workos-python/pull/438
  • Bump to v5.20.1 by @stanleyphu in https://github.com/workos/workos-python/pull/439

New Contributors

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

Full Changelog: https://github.com/workos/workos-python/compare/v5.20.0...v5.20.1

April 25, 2025

v5.20.0

April 25, 2025

What's Changed

  • Bump cryptography to ~=44.0.2 (#436)
  • Add custom_attributes field to SSO Profile (#434)

New Contributors

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

Full Changelog: https://github.com/workos/workos-python/compare/v5.19.1...v5.20.0

April 17, 2025

v5.19.1

April 17, 2025

What's Changed

  • Allow organization_id to be optional on Connection for OAuth connections (#432)
  • Fix async session tests (#433)

Full Changelog: v5.19.0...v5.19.1

April 15, 2025

v5.19.0

April 15, 2025

What's Changed

  • Added password_reset.succeeded event type (https://github.com/workos/workos-python/pull/429)

Full Changelog: https://github.com/workos/workos-python/compare/v5.18.1...v5.19.0

April 1, 2025

v5.18.1

April 1, 2025

What's Changed

  • Use AsyncSession class for async load_sealed_session (#427)

Full Changelog: https://github.com/workos/workos-python/compare/v5.18.0...v5.18.1

March 31, 2025

v5.18.0

March 31, 2025

What's Changed

  • Loosen dependency version constraints by @mrcljx in #424
  • Add async support for load_sealed_session in #425

New Contributors

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

Full Changelog: https://github.com/workos/workos-python/compare/v5.17.0...v5.18.0

March 21, 2025

v5.17.0

March 21, 2025

What's Changed

  • Add email standard attribute to DirectoryUser
  • Mark emails, job_title, and username standard attributes as deprecated. Enable the equivalent auto-mapped custom attributes instead (#413)

Full Changelog: https://github.com/workos/workos-python/compare/v5.16.0...v5.17.0

March 19, 2025

v5.16.0

March 19, 2025

What's Changed

  • Add metadata and external id to users and organizations from https://github.com/workos/workos-python/pull/420

Full Changelog: https://github.com/workos/workos-python/compare/v5.15.1...v5.16.0

March 17, 2025

v5.15.1

March 17, 2025

What's Changed

  • Add missing list of workos module public symbols to allow importing like from workos import WorkOSClient (#415)

Full Changelog: https://github.com/workos/workos-python/compare/v5.15.0...v5.15.1

February 14, 2025

v5.15.0

February 14, 2025

What's Changed

Added

  • Added last_sign_in_at to user (#408)

Changed

  • Fixed handling access tokens with aud claim (#409)

Full Changelog: https://github.com/workos/workos-python/compare/v5.14.0...v5.15.0

February 3, 2025

v5.14.0

February 3, 2025

What's Changed

  • Add intent_options parameter on Portal.generate_link() method by @jonatascastro12 in https://github.com/workos/workos-python/pull/406
January 24, 2025

v5.13.1

January 24, 2025

What's Changed

  • Adjust dependency version pinning to allow for more cryptography versions (#404)

Full Changelog: https://github.com/workos/workos-python/compare/v5.13.0...v5.13.1

January 14, 2025

v5.13.0

January 14, 2025

Added

  • Added strip_customer_id parameter to update_organization (#401)
  • Added return_to parameter to get_logout_url (#400)

Full Changelog: https://github.com/workos/workos-python/compare/v5.12.1...v5.13.0

January 13, 2025

v5.12.1

January 13, 2025

What's Changed

  • Allows proxies to be properly set via environment variables (#398). If you use the standard HTTP proxy environment variables (e.g. HTTPS_PROXY), it's recommend to verify there's no behavior change in your environment and adjust them if needed.

Full Changelog: https://github.com/workos/workos-python/compare/v5.12.0...v5.12.1

January 7, 2025

v5.12.0

January 7, 2025

Added

  • Support screen_hint in user_management.get_authorization_url by @faroceann in https://github.com/workos/workos-python/pull/396

Full Changelog: https://github.com/workos/workos-python/compare/v5.11.1...v5.12.0

January 6, 2025

v5.11.1

January 6, 2025

What's Changed

  • Update dependency versions pinning (#394)

Full Changelog: https://github.com/workos/workos-python/compare/v5.11.0...v5.11.1

January 2, 2025

v5.11.0

January 2, 2025

What's Changed

  • Add GET /organization/:orgId/roles API support (#392)

Full Changelog: https://github.com/workos/workos-python/compare/v5.10.0...v5.11.0

December 2, 2024

v5.10.0

December 2, 2024

What's Changed

  • Propagate ConflictExceptions properly by @mattgd in https://github.com/workos/workos-python/pull/389
  • Adds session helpers by @PaulAsjes in https://github.com/workos/workos-python/pull/384

Full Changelog: https://github.com/workos/workos-python/compare/v5.9.0...v5.10.0

November 26, 2024

v5.9.0

November 26, 2024

What's Changed

  • Add options to Connection resource and add sso.update_connection() in https://github.com/workos/workos-python/pull/386

Full Changelog: https://github.com/workos/workos-python/compare/v5.8.0...v5.9.0

November 22, 2024

v5.8.0

November 22, 2024

Added

  • Added prompt option to the User Management get_authorization_url method (#383)
November 15, 2024

v5.7.0

November 15, 2024

Added

  • Add widgets module and widget get token API endpoint (#380)
  • Add "Passkey" to AuthenticationMethod (#382)

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

November 6, 2024

v5.6.0

November 6, 2024

What's Changed

  • Add oauth_tokens to AuthkitAuthenticationResponse in https://github.com/workos/workos-python/pull/378

Full Changelog: https://github.com/workos/workos-python/compare/v5.5.1...v5.6.0

October 17, 2024

v5.5.1

October 17, 2024

What's Changed

  • Update pydantic and mypy dependencies #374

Full Changelog: https://github.com/workos/workos-python/compare/v5.5.0...v5.5.1

October 16, 2024

v5.5.0

October 16, 2024

What's Changed

  • Add "role" to profile in https://github.com/workos/workos-python/pull/372

Full Changelog: https://github.com/workos/workos-python/compare/v5.4.4...v5.5.0

October 1, 2024

v5.4.4

October 1, 2024

What's Changed

  • Fix dsync.activated event parsing for Events API when domains present #369

Full Changelog: https://github.com/workos/workos-python/compare/v5.4.3...v5.4.4

September 26, 2024

v5.4.3

September 26, 2024

What's Changed

  • Add missing organization membership webhook events to union #366

Full Changelog: https://github.com/workos/workos-python/compare/v5.4.2...v5.4.3