workos 0.8.7

WorkOS Python Client

workos-python

Python SDK to conveniently access the WorkOS API, hosted on PyPi.

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 using SSO:

import workos

workos.api_key = "sk_abdsomecharactersm284"
workos.client_id = "client_b27needthisforssotemxo"

A client is available as an entry point to the WorkOS feature set:

from workos import client

# URL to redirect a User so they can 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)