Add Directory Sync to your Django app using WorkOS

September 2, 2021

If your SaaS product is built with Python’s Django web framework and you want to incorporate Directory Sync functionality, you can do a dry-run of the Directory Sync integration on our example Django app which makes use of the WorkOS Python SDK.

If you get stuck while following the steps below and aren't able to resolve the issue by reading our API reference or Directory Sync Setup Guide, reach out to us at [email protected] so we can help.

Prerequisites

  • Python 3.6+

Directory Sync Setup with WorkOS

First, follow the Create a New Directory Connection step in the WorkOS Directory Sync guide.

If you get stuck, please reach out to us at [email protected] so we can help.

Django Project Setup

Clone Directory

1. In your CLI, navigate to the directory into which you want to clone this git repo.

2. Clone this git repo using your preferred secure method (HTTPS or SSH).

or


Install Dependencies

3. Navigate to the cloned repo.


4. Create and source a Python virtual environment. You should then see (env) at the beginning of your command-line prompt.


5. Install the cloned app's dependencies.


Set Environment Variables

6. Obtain and make note of the following values. In the next step, these will be set as environment variables.

  • Your WorkOS API key
  • Your DIRECTORY_ID, in the format directory_<random-alphanumeric-string>, retrievable from the URL in the Directory Sync area of the WorkOS dashboard:

7. Ensure you're in the root directory for the example app, python-django-directory-sync-example/. Create a .env file to securely store the environment variables. Open this file with the Nano text editor. (This file is listed in this repo's .gitignore file, so your sensitive information will not be checked into version control.)



8. Once the Nano text editor opens, you can directly edit the .env file by listing the environment variables:

To exit the Nano text editor, type CTRL + x. When prompted to "Save modified buffer", type Y, then press the Enter or Return key.

9. Source the environment variables so they are accessible to the operating system.

You can ensure the environment variables were set correctly by running the following commands. The output should match the corresponding values.


Run Django Migrations and Start Server

10. Run the Django migrations. Again, ensure you're in the python-django-directory-sync-example/ directory where the manage.py file is.


You should see output like:



11. Start the server.


You'll know the server is running when you see no errors in the CLI, and output similar to the following is displayed:

12. Once the server is running, navigate to http://localhost:8000/users and http://localhost:8000/groups to try out Directory Sync!

Need help?

When you clone this repo, the DEBUG setting is False by default in workos_django/settings.py. You can set DEBUG=True if you need to troubleshoot something during the tutorial, but you must use DEBUG=False in order to successfully connect to the WorkOS API.

If you get stuck and aren't able to resolve the issue by reading our API reference or tutorials, please  reach out to us at [email protected] and we'll help you out.

Start Integrating Today
Create an account to begin adding enterprise-ready features to your application today.
Get Started

This site uses cookies to improve your experience. Please accept the use of cookies on this site. You can review our cookie policy here and our privacy policy here. If you choose to refuse, functionality of this site will be limited.