Redesign Audit Logs Example Application (#31)

* Implement new design skeleton

* Update content navigation logic

* Update tab content

* Update to use pythonic operators

* updates requirements

* Update all WorkOS SDK versions in requirements

* Add org selection, table ui, and pagination example to login page

* Update readme to align with new UI

* Update readme to align with new UI

* Remove print statements

* Refactor app navigation

* Remove unused template

* Add pagination table to dsync app home template

Co-authored-by: Adam Wolfman <[email protected]>
Co-authored-by: Adam Wolfman <[email protected]>
Co-authored-by: Adam <[email protected]>

Author: 4 people

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

@@ -9,5 +9,5 @@ MarkupSafe==2.0.1
 requests==2.26.0
 urllib3==1.26.7
 Werkzeug==2.0.1
-workos>=1.20.2
+workos>=1.21.0
 python-dotenv

python-flask-audit-logs-example/README.md

@@ -75,6 +75,7 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
    ```bash
    (env) $ echo $WORKOS_API_KEY
    (env) $ echo $WORKOS_CLIENT_ID
+   (env) $ echo $APP_SECRET_KEY
    ```
 
 9. The final setup step is to start the server.
@@ -106,19 +107,16 @@ You can stop the local Flask server for now by entering `CTRL + c` on the comman
 
 ## Audit Logs Setup with WorkOS
 
-10. Follow the [Audit Logs configuration steps](https://workos.com/docs/audit-logs/emit-an-audit-log-event/sign-in-to-your-workos-dashboard-account-and-configure-audit-log-event-schemas) to set up the following 5 events that are sent with this example:
+10. Follow the [Audit Logs configuration steps](https://workos.com/docs/audit-logs/emit-an-audit-log-event/sign-in-to-your-workos-dashboard-account-and-configure-audit-log-event-schemas) to set up the following 2 events that are sent with this example:
 
-Action title: "user.signed_in" | Target type: "team"
-Action title: "user.logged_out" | Target type: "team"
 Action title: "user.organization_set" | Target type: "team"
 Action title: "user.organization_deleted" | Target type: "team"
-Action title: "user.connection_deleted" | Target type: "team"
 
-11. Next, take note of the Organization ID for the Org which you will be sending the Audit Log events for. This ID gets entered into the splash page of the example application.
+11. Configure the Admin Portal Redirect URI.
 
-12. Once you enter the Organization ID and submit it, you will be brought to the page where you'll be able to send the audit log events that were just configured. You'll also notice that the action of setting the Organization triggered an Audit Log already. Click the buttons to send the respective events.
+Navigate to the Configuration tab in your WorkOS Dshboard. From there click the Admin Portal tab. Click the Edit Admin Portal Redirect Links button and add "http://localhost:5000" to the "When clicking the back navigation, return users to:" input, then click Save Redirect Links.
 
-13. To obtain a CSV of the Audit Log events that were sent for the last 30 days, click the "Export Events" button. This will bring you to a new page where you can download the events. Downloading the events is a 2 step process. First you need to create the report by clicking the "Generate CSV" button. Then click the "Access CSV" button to download a CSV of the Audit Log events for the selected Organization for the past 30 days.
+12. To obtain a CSV of the Audit Log events that were sent for the last 30 days, click the "Export Events" tab. This will bring you to a new page where you can download the events. Downloading the events is a 2 step process. First you need to create the report by clicking the "Generate CSV" button. Then click the "Access CSV" button to download a CSV of the Audit Log events for the selected Organization for the past 30 days. You may also adjust the time range using the form inputs.
 
 ## Need help?
 

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

@@ -5,20 +5,20 @@
 import workos
 from datetime import datetime, timedelta
 from audit_log_events import (
-    user_signed_in,
-    user_logged_out,
-    user_connection_deleted,
-    user_organization_deleted,
     user_organization_set,
 )
+from flask_lucide import Lucide
+
 
 # Flask Setup
 DEBUG = False
 app = Flask(__name__)
 app.secret_key = os.getenv("APP_SECRET_KEY")
 
-# WorkOS Setup
+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
@@ -33,19 +33,39 @@ def to_pretty_json(value):
 
 @app.route("/", methods=["POST", "GET"])
 def index():
-    try:
+    try:        
+        link = workos.client.portal.generate_link(
+            organization=session["organization_id"], intent="audit_logs"
+        )
+        today = datetime.today()
+        last_month = today - timedelta(days=30)
         return render_template(
             "send_events.html",
+            link=link["link"],
             organization_id=session["organization_id"],
             org_name=session["organization_name"],
+            last_month_iso=last_month.isoformat(),
+            today_iso=today.isoformat(),
         )
     except KeyError:
-        return render_template("login.html")
+        before = request.args.get("before")
+        after = request.args.get("after")
+        organizations = workos.client.organizations.list_organizations(
+            before=before, after=after, limit=5, order=None
+        )
+        before = organizations["listMetadata"]["before"]
+        after = organizations["listMetadata"]["after"]
+        return render_template(
+            "login.html",
+            organizations=organizations["data"], 
+            before=before, 
+            after=after
+        )
 
 
 @app.route("/set_org", methods=["POST", "GET"])
 def set_org():
-    organization_id = request.form["org"]
+    organization_id = request.args.get("id")
     session["organization_id"] = organization_id
     organization_set = workos.client.audit_logs.create_event(
         organization_id, user_organization_set
@@ -58,59 +78,101 @@ def set_org():
 
 @app.route("/send_event", methods=["POST", "GET"])
 def send_event():
-    event_type = request.form["event"]
+    event_version, actor_name, actor_type, target_name, target_type = (
+        request.form["event-version"],
+        request.form["actor-name"],
+        request.form["actor-type"],
+        request.form["target-name"],
+        request.form["target-type"],
+    )
     organization_id = session["organization_id"]
-    events = [
-        user_signed_in,
-        user_logged_out,
-        user_organization_deleted,
-        user_connection_deleted,
-    ]
-    event = events[int(event_type)]
+
+    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",
+            },
+        ],
+        "context": {
+            "location": "123.123.123.123",
+            "user_agent": "Chrome/104.0.0.0",
+        },
+    }
     organization_set = workos.client.audit_logs.create_event(organization_id, event)
     return redirect("/")
 
 
 @app.route("/export_events", methods=["POST", "GET"])
 def export_events():
+    today = datetime.today()
+    last_month = today - timedelta(days=30)
     organization_id = session["organization_id"]
     return render_template(
-        "export_events.html",
+        "send_events.html",
         organization_id=organization_id,
         org_name=session["organization_name"],
+        last_month_iso=last_month.isoformat(),
+        today_iso=today.isoformat(),
     )
 
 
 @app.route("/get_events", methods=["POST", "GET"])
 def get_events():
     organization_id = session["organization_id"]
     event_type = request.form["event"]
-    today = datetime.today()
-    last_month = today - timedelta(days=30)
-    last_month_iso = last_month.isoformat()
-    today_iso = today.isoformat()
 
     if event_type == "generate_csv":
-        create_export_response = workos.client.audit_logs.create_export(
-            organization=organization_id,
-            range_start=last_month_iso,
-            range_end=today_iso,
-        )
-        session["export_id"] = create_export_response.to_dict()["id"]
-
+        if request.form["filter-actions"] != "":
+            actions = request.form["filter-actions"]
+        else:
+            actions = None
+        if request.form["filter-actors"] != "":
+            actors = request.form["filter-actors"]
+        else:
+            actors = None
+        if request.form["filter-targets"] != "":
+            targets = request.form["filter-targets"]
+        else:
+            targets = None
+
+        try:
+
+            create_export_response = workos.client.audit_logs.create_export(
+                organization=organization_id,
+                range_start=request.form["range-start"],
+                range_end=request.form["range-end"],
+                actions=actions,
+                actors=actors,
+                targets=targets,
+            )
+            session["export_id"] = create_export_response.to_dict()["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"])
 
-    return redirect("export_events")
 
 @app.route("/events", methods=["GET"])
 def events():
     link = workos.client.portal.generate_link(
         organization=session["organization_id"], intent="audit_logs"
     )
-    
+
     return redirect(link["link"])
 
 

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

@@ -1,43 +1,5 @@
 from datetime import datetime
 
-user_signed_in = {
-    "action": "user.signed_in",
-    "occurred_at": datetime.now().isoformat(),
-    "actor": {
-        "type": "user",
-        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-    },
-    "targets": [
-        {
-            "type": "team",
-            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
-        },
-    ],
-    "context": {
-        "location": "123.123.123.123",
-        "user_agent": "Chrome/104.0.0.0",
-    },
-}
-
-user_logged_out = {
-    "action": "user.logged_out",
-    "occurred_at": datetime.now().isoformat(),
-    "actor": {
-        "type": "user",
-        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-    },
-    "targets": [
-        {
-            "type": "team",
-            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
-        },
-    ],
-    "context": {
-        "location": "123.123.123.123",
-        "user_agent": "Chrome/104.0.0.0",
-    },
-}
-
 user_organization_set = {
     "action": "user.organization_set",
     "occurred_at": datetime.now().isoformat(),
@@ -56,41 +18,3 @@
         "user_agent": "Chrome/104.0.0.0",
     },
 }
-
-user_organization_deleted = {
-    "action": "user.organization_deleted",
-    "occurred_at": datetime.now().isoformat(),
-    "actor": {
-        "type": "user",
-        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-    },
-    "targets": [
-        {
-            "type": "team",
-            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
-        },
-    ],
-    "context": {
-        "location": "123.123.123.123",
-        "user_agent": "Chrome/104.0.0.0",
-    },
-}
-
-user_connection_deleted = {
-    "action": "user.connection_deleted",
-    "occurred_at": datetime.now().isoformat(),
-    "actor": {
-        "type": "user",
-        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
-    },
-    "targets": [
-        {
-            "type": "team",
-            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
-        },
-    ],
-    "context": {
-        "location": "123.123.123.123",
-        "user_agent": "Chrome/104.0.0.0",
-    },
-}

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

@@ -1,3 +1,5 @@
-Flask==2.0.0
-workos>=1.20.2
-python-dotenv
+Flask==2.0.3
+Jinja2==3.1.1
+workos>=1.21.0
+python-dotenv
+flask-lucide==0.2.0