Update sample apps for Python SDK v5

python-flask-admin-portal-example/app.py

@@ -1,10 +1,9 @@
+from email.mime import base
 import os
-
-from flask import Flask, redirect, render_template, request, url_for
+from flask import Flask, redirect, render_template, request
 import workos
-from workos import client as workos_client
-from workos import portal
 from flask_lucide import Lucide
+from workos.types import DomainDataInput
 
 
 # Flask Setup
@@ -13,9 +12,12 @@
 lucide = Lucide(app)
 
 # WorkOS Setup
-workos.api_key = os.getenv("WORKOS_API_KEY")
-workos.project_id = os.getenv("WORKOS_CLIENT_ID")
-workos.base_api_url = "http://localhost:7000/" if DEBUG else workos.base_api_url
+base_api_url = "http://localhost:7000/" if DEBUG else None
+workos_client = workos.WorkOSClient(
+    api_key=os.getenv("WORKOS_API_KEY"),
+    client_id=os.getenv("WORKOS_CLIENT_ID"),
+    base_url=base_api_url,
+)
 
 
 @app.route("/")
@@ -32,21 +34,38 @@ def provision_enterprise():
 
     # Check if a matching domain already exists and set global org_id if there is a match
     orgs = workos_client.organizations.list_organizations(domains=organization_domains)
-    if len(orgs["data"]) > 0:
-        org_id = orgs["data"][0]["id"]
+    if len(orgs.data) > 0:
+        org_id = orgs.data[0].id
 
     # Otherwise create a new Organization and set the global org_id
     else:
+        domain_data = list(
+            map(
+                lambda domain: DomainDataInput({"domain": domain, "state": "verified"}),
+                organization_domains,
+            )
+        )
+
         organization = workos_client.organizations.create_organization(
-            {"name": organization_name, "domains": organization_domains}
+            name=organization_name,
+            domain_data=domain_data,
         )
-        org_id = organization["id"]
+        org_id = organization.id
 
     return render_template("org_logged_in.html")
 
 
 @app.route("/launch_admin_portal", methods=["GET", "POST"])
 def launch_admin_portal():
     intent = request.args.get("intent")
-    portal_link = workos_client.portal.generate_link(organization=org_id, intent=intent)
-    return redirect(portal_link["link"])
+
+    if intent is None:
+        return "Missing intent parameter", 400
+
+    if not intent in tuple(("audit_logs", "dsync", "log_streams", "sso")):
+        return "Invalid intent parameter", 400
+
+    portal_link = workos_client.portal.generate_link(
+        organization_id=org_id, intent=intent
+    )
+    return redirect(portal_link.link)

python-flask-admin-portal-example/requirements.txt

@@ -1,14 +1,14 @@
 certifi==2021.5.30
 charset-normalizer==2.0.6
 click==8.0.1
-Flask==2.0.1
+Flask==2.0.3
 idna==3.2
 itsdangerous==2.0.1
 Jinja2==3.0.1
 MarkupSafe==2.0.1
 requests==2.26.0
 urllib3==1.26.7
 Werkzeug==2.0.1
-workos>=1.23.3
+workos>=5.0.0
 python-dotenv
 flask-lucide==0.2.0

python-flask-audit-logs-example/app.py

@@ -1,12 +1,12 @@
 import json
 import os
-from urllib.parse import urlparse, parse_qs
-from flask import Flask, session, redirect, render_template, request, url_for
+from flask import Flask, session, redirect, render_template, request
 import workos
 from datetime import datetime, timedelta
 from audit_log_events import (
     user_organization_set,
 )
+from workos.audit_logs import AuditLogEvent
 from flask_lucide import Lucide
 
 
@@ -19,9 +19,12 @@
 
 
 # WorkOS Setup
-workos.api_key = os.getenv("WORKOS_API_KEY")
-workos.project_id = os.getenv("WORKOS_CLIENT_ID")
-workos.base_api_url = "http://localhost:7000/" if DEBUG else workos.base_api_url
+base_api_url = "http://localhost:7000/" if DEBUG else None
+workos_client = workos.WorkOSClient(
+    api_key=os.getenv("WORKOS_API_KEY"),
+    client_id=os.getenv("WORKOS_CLIENT_ID"),
+    base_url=base_api_url,
+)
 
 
 def to_pretty_json(value):
@@ -34,14 +37,14 @@ def to_pretty_json(value):
 @app.route("/", methods=["POST", "GET"])
 def index():
     try:
-        link = workos.client.portal.generate_link(
-            organization=session["organization_id"], intent="audit_logs"
+        link = workos_client.portal.generate_link(
+            organization_id=session["organization_id"], intent="audit_logs"
         )
         today = datetime.today()
         last_month = today - timedelta(days=30)
         return render_template(
             "send_events.html",
-            link=link["link"],
+            link=link.link,
             organization_id=session["organization_id"],
             org_name=session["organization_name"],
             last_month_iso=last_month.isoformat(),
@@ -50,29 +53,29 @@ def index():
     except KeyError:
         before = request.args.get("before")
         after = request.args.get("after")
-        organizations = workos.client.organizations.list_organizations(
-            before=before, after=after, limit=5, order=None
+        organizations = workos_client.organizations.list_organizations(
+            before=before, after=after, limit=5, order="desc"
         )
-        before = organizations["listMetadata"]["before"]
-        after = organizations["listMetadata"]["after"]
+        before = organizations.list_metadata.before
+        after = organizations.list_metadata.after
         return render_template(
             "login.html",
-            organizations=organizations["data"],
+            organizations=organizations.data,
             before=before,
             after=after,
         )
 
 
 @app.route("/set_org", methods=["POST", "GET"])
 def set_org():
-    organization_id = request.args.get("id")
+    organization_id = request.args.get("id") or request.form["organization_id"]
+
     session["organization_id"] = organization_id
-    organization_set = workos.client.audit_logs.create_event(
-        organization_id, user_organization_set
+    workos_client.audit_logs.create_event(
+        organization_id=organization_id, event=user_organization_set
     )
-    org = workos.client.organizations.get_organization(organization_id)
-    org_name = org["name"]
-    session["organization_name"] = org_name
+    org = workos_client.organizations.get_organization(organization_id)
+    session["organization_name"] = org.name
     return redirect("/")
 
 
@@ -87,28 +90,32 @@ def send_event():
     )
     organization_id = session["organization_id"]
 
-    event = {
-        "action": "user.organization_deleted",
-        "version": int(event_version),
-        "occurred_at": datetime.now().isoformat(),
-        "actor": {
-            "type": actor_type,
-            "name": actor_name,
-            "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-        },
-        "targets": [
-            {
-                "type": target_type,
-                "name": target_name,
-                "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+    event = AuditLogEvent(
+        {
+            "action": "user.organization_deleted",
+            "version": int(event_version),
+            "occurred_at": datetime.now().isoformat(),
+            "actor": {
+                "type": actor_type,
+                "name": actor_name,
+                "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
             },
-        ],
-        "context": {
-            "location": "123.123.123.123",
-            "user_agent": "Chrome/104.0.0.0",
-        },
-    }
-    organization_set = workos.client.audit_logs.create_event(organization_id, event)
+            "targets": [
+                {
+                    "type": target_type,
+                    "name": target_name,
+                    "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+                },
+            ],
+            "context": {
+                "location": "123.123.123.123",
+                "user_agent": "Chrome/104.0.0.0",
+            },
+        }
+    )
+    organization_set = workos_client.audit_logs.create_event(
+        organization_id=organization_id, event=event
+    )
     return redirect("/")
 
 
@@ -147,33 +154,40 @@ def get_events():
 
         try:
 
-            create_export_response = workos.client.audit_logs.create_export(
-                organization=organization_id,
+            create_export_response = workos_client.audit_logs.create_export(
+                organization_id=organization_id,
                 range_start=request.form["range-start"],
                 range_end=request.form["range-end"],
                 actions=actions,
-                actors=actors,
+                actor_names=actors,
                 targets=targets,
             )
-            session["export_id"] = create_export_response.to_dict()["id"]
+            session["export_id"] = create_export_response.id
 
             return redirect("export_events")
         except Exception as e:
             print(str(e))
             return redirect("/")
     if event_type == "access_csv":
         export_id = session["export_id"]
-        fetch_export_response = workos.client.audit_logs.get_export(export_id)
-        return redirect(fetch_export_response.to_dict()["url"])
+        fetch_export_response = workos_client.audit_logs.get_export(export_id)
+        if fetch_export_response.url is None:
+            return redirect("/")
+
+        return redirect(fetch_export_response.url)
 
 
 @app.route("/events", methods=["GET"])
 def events():
-    link = workos.client.portal.generate_link(
-        organization=session["organization_id"], intent=request.args.get("intent")
+    intent = request.args.get("intent")
+    if not intent == "audit_logs":
+        return redirect("/")
+
+    link = workos_client.portal.generate_link(
+        organization_id=session["organization_id"], intent=intent
     )
 
-    return redirect(link["link"])
+    return redirect(link.link)
 
 
 @app.route("/logout")

python-flask-audit-logs-example/audit_log_events.py

@@ -1,20 +1,23 @@
 from datetime import datetime
+from workos.audit_logs import AuditLogEvent
 
-user_organization_set = {
-    "action": "user.organization_set",
-    "occurred_at": datetime.now().isoformat(),
-    "actor": {
-        "type": "user",
-        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-    },
-    "targets": [
-        {
-            "type": "team",
-            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+user_organization_set = AuditLogEvent(
+    {
+        "action": "user.organization_set",
+        "occurred_at": datetime.now().isoformat(),
+        "actor": {
+            "type": "user",
+            "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
         },
-    ],
-    "context": {
-        "location": "123.123.123.123",
-        "user_agent": "Chrome/104.0.0.0",
-    },
-}
+        "targets": [
+            {
+                "type": "organization",
+                "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+            },
+        ],
+        "context": {
+            "location": "123.123.123.123",
+            "user_agent": "Chrome/104.0.0.0",
+        },
+    }
+)

python-flask-audit-logs-example/requirements.txt

@@ -1,5 +1,6 @@
 Flask==2.0.3
 Jinja2==3.1.1
-workos>=1.23.3
+workos>=5.0.0
 python-dotenv
-flask-lucide==0.2.0
+flask-lucide==0.2.0
+Werkzeug==2.0.1