If your SaaS product is built with Python’s Flask web framework and you want to incorporate WorkOS’ Admin Portal functionality, you can do a dry-run of the Admin Portal integration on our example Django app which makes use of the WorkOS Python SDK.
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).
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.
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 WORKOS_CLIENT_ID, in the format client_<random-alphanumeric-string>, retrievable from the WorkOS dashboard under the Configuration tab.
7. Ensure you're in the root directory for the example app, python-flask-admin-portal-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.
10. Update the Admin Portal Redirect Link in the "Configuration" page of your WorkOS Dashboard. The URL should be http://localhost:5000.
After an Admin Portal user creates an SSO connection using the Admin Portal, they need to be redirected to a webpage within your application (usually this webpage confirms successful creation of the connection). To configure which webpage this is, enter the webpage’s URL in the Configuration section of your WorkOS dashboard under the “Admin Portal Redirect Link” header. For production usage this URL must begin with HTTPS, but for development purposes the URL can begin with HTTP.
11. The final setup step is to 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. Navigate to http://localhost:5000 in your web browser to view the homepage of the Admin Portal example app. Enter the name of the new Organization to be created and the names of all of the Organization's associated domains.
Then, click the buttons to either create a new SSO connection or a new Directory Sync connection.
Congratulations! You just added the WorkOS Admin Portal to your Flask app.
If you get stuck and aren't able to resolve the issue by reading our API reference or tutorials, you can reach out to us at [email protected] and we'll lend a hand.