Skip to content

docs: Rename Sign-in URL to Initiate login URI in README #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joyashin merged 1 commit into from
Sep 14, 2026
Merged

docs: Rename Sign-in URL to Initiate login URI in README #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,21 +297,22 @@ export default function HomePage() {
> no longer supported — see [Migrating from 0.4.x](#migrating-from-04x)
> below.

### Sign-in URL
### Initiate login URI

The sign-in route above doubles as your **Sign-in URL** (also known
as `initiate_login_uri`) — the URL WorkOS redirects to when it needs to
The sign-in route above doubles as your **Initiate login URI**
(`initiate_login_uri`) — the URL WorkOS redirects to when it needs to
start an authentication flow on your app's behalf (for example, when an
admin impersonates a user from the dashboard, or when a password-reset
email lands on a device that is not already signed in).

In the [WorkOS dashboard](https://dashboard.workos.com), go to
**Redirects** and set the **Sign-in URL** to the public URL of the
In the [WorkOS dashboard](https://dashboard.workos.com), open
**Applications**, select your application, go to the **Redirects** tab,
and set the **Initiate login URI** to the public URL of the
route (e.g., `http://localhost:5173/login` in development,
`https://your-app.com/login` in production).

> [!IMPORTANT]
> A configured Sign-in URL is required for
> A configured Initiate login URI is required for
> [impersonation](https://workos.com/docs/user-management/impersonation)
> to work. Without it, WorkOS-initiated flows (such as impersonating a
> user from the dashboard) redirect directly to your callback URL
Expand Down Expand Up @@ -632,7 +633,7 @@ through your application's sign-in flow. Because this library enforces
PKCE/CSRF verification on every callback, the request is rejected when
the required `state` parameter is missing.

**Fix:** Configure a [Sign-in URL](#sign-in-url) in your
**Fix:** Configure an [Initiate login URI](#initiate-login-uri) in your
WorkOS dashboard so that impersonation flows route through your app
first, allowing the PKCE verifier and CSRF state to be set up before
redirecting to WorkOS.
Expand Down
Loading