From 8ad6a34b59b26170f669a898cb4e241291873af1 Mon Sep 17 00:00:00 2001 From: julie Date: Mon, 14 Sep 2026 17:47:03 +0000 Subject: [PATCH 1/2] docs: Rename Sign-in URL to Initiate login URI in README Match the WorkOS dashboard, which labels this setting "Initiate login URI" under an application's Redirects tab. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 05f1b13..bd03121 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ npm install @workos-inc/authkit-react ### 1. Configure the WorkOS Dashboard -- Add a **Redirect URI** (e.g. `http://localhost:5173`) on the **Redirects** page. This is where WorkOS sends users after they authenticate. +- Add a **Redirect URI** (e.g. `http://localhost:5173`) on your application's **Redirects** tab. This is where WorkOS sends users after they authenticate. - Add your app's origin (e.g. `http://localhost:5173`) to the allowed origins list on the **Authentication** page of the [WorkOS Dashboard](https://dashboard.workos.com). ### 2. Wrap your app in `AuthKitProvider` @@ -30,9 +30,9 @@ createRoot(document.getElementById("root")).render( ### 3. Add a `/login` route -Some authentication flows are initiated outside your app — for example, when an admin impersonates a user from the WorkOS Dashboard, or when a third-party triggers login via your app's Sign-in URL. These flows redirect the user to a well-known login path in your app, which must then start the OAuth flow. +Some authentication flows are initiated outside your app — for example, when an admin impersonates a user from the WorkOS Dashboard, or when a third-party triggers login via your app's Initiate login URI. These flows redirect the user to a well-known login path in your app, which must then start the OAuth flow. -Register a `/login` URL (e.g. `http://localhost:5173/login`) as the **Sign-in URL** on the same **Redirects** page, then handle it in your app: +Register a `/login` URL (e.g. `http://localhost:5173/login`) as the **Initiate login URI** on the same **Redirects** tab, then handle it in your app: ```jsx import { useAuth } from "@workos-inc/authkit-react"; From 600e1534621cbb557f57e96f0bdfc19e3c7aa8e8 Mon Sep 17 00:00:00 2001 From: julie Date: Mon, 14 Sep 2026 18:09:28 +0000 Subject: [PATCH 2/2] docs: Clarify dashboard path for Initiate login URI --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bd03121..a9491fe 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ createRoot(document.getElementById("root")).render( Some authentication flows are initiated outside your app — for example, when an admin impersonates a user from the WorkOS Dashboard, or when a third-party triggers login via your app's Initiate login URI. These flows redirect the user to a well-known login path in your app, which must then start the OAuth flow. -Register a `/login` URL (e.g. `http://localhost:5173/login`) as the **Initiate login URI** on the same **Redirects** tab, then handle it in your app: +In the [WorkOS dashboard](https://dashboard.workos.com), open **Applications**, select your application, go to the **Redirects** tab. Register a `/login` URL (e.g. `http://localhost:5173/login`) as the **Initiate login URI** for your application, then handle it in your app: ```jsx import { useAuth } from "@workos-inc/authkit-react";