Skip to content

docs: add sign-in endpoint setup and impersonation requirements#402

Open
nicknisi wants to merge 1 commit intomainfrom
docs/sign-in-endpoint-setup
Open

docs: add sign-in endpoint setup and impersonation requirements#402
nicknisi wants to merge 1 commit intomainfrom
docs/sign-in-endpoint-setup

Conversation

@nicknisi
Copy link
Copy Markdown
Member

@nicknisi nicknisi commented Apr 9, 2026

Summary

  • Adds a Sign-in endpoint section to the README Setup guide with a route example and WorkOS dashboard configuration instructions
  • Adds a note to the Visualizing an impersonation section that a sign-in endpoint is required
  • Adds a Troubleshooting entry for the Missing required auth parameter error during dashboard impersonation

Context: #400 — dashboard impersonation fails with v3 because WorkOS redirects directly to the callback without state. The fix is to configure a sign-in endpoint (initiate_login_uri) so impersonation routes through the app first, allowing PKCE/state to be set up normally.

Add documentation for configuring the sign-in endpoint (initiate_login_uri)
which is required for WorkOS-initiated flows like dashboard impersonation
to work with v3's PKCE/CSRF verification.

- New "Sign-in endpoint" section in Setup with route example and dashboard config
- Note in "Visualizing an impersonation" that sign-in endpoint is required
- Troubleshooting entry for "Missing required auth parameter" during impersonation

Closes #400

### Sign-in endpoint

Create a route that initiates the AuthKit sign-in flow. This route is used as the **Sign-in endpoint** (also known as `initiate_login_uri`) in your WorkOS dashboard settings.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a documentation URL we can link to here for folks who want/need more info?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants