Skip to main content

WorkOS Python Client

Project description

workos-python

Python SDK to conveniently access the WorkOS API.

Installation

To install from PyPi, run the following:

pip install workos

To install from source, clone the repo and run the following:

python setup.py install

Getting Started

The package will need to be configured with your api key at a minimum and client id if you plan on utilizing SSO:

import workos

workos.api_key = sk_abdsomecharactersm284
workos.client_id = client_b27needthisforssotemxo

For your convenience, a client is available as an entry point for accessing the WorkOS feature set:

from workos import client

# URL to redirect a User to to initiate the WorkOS OAuth 2.0 workflow
client.sso.get_authorization_url(
    domain='customer-domain.com',
    redirect_uri='my-domain.com/auth/callback',
    state={
        'stuff': 'from_the_original_request',
        'more_things': 'ill_get_it_all_back_when_oauth_is_complete',
    }
)

# Get the WorkOSProfile for an authenticated User
client.get_profile(oauth_code)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for workos, version 0.8.5
Filename, size File type Python version Upload date Hashes
Filename, size workos-0.8.5-py3-none-any.whl (16.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size workos-0.8.5.tar.gz (11.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page