Account Access
Complete guide to authentication workflows in PayloadRelay, including SSO and recovery.
8 min read
Use this guide for login, recovery, confirmation, and invitation access flows.
Purpose
This page covers:
- Login (password and OAuth).
- Password reset request + consume.
- Email confirmation preview + consume.
- Organization invitation preview + accept.
Prerequisites and permissions
- Public pages:
/login,/forgot-password,/password-reset,/confirm-email,/invite/accept. - Signup may be disabled in closed-beta environments.
- Valid token required for confirm/reset/invite token flows.
Step-by-step workflow
A. Sign in
- Open
/login. - Choose email/password, or OAuth (
Google,Microsoft,Apple) when enabled. - Successful auth sets an HttpOnly session cookie and redirects to the app.
If email is unconfirmed, use Resend confirmation email and complete the confirm flow.
B. Reset password
- Open
/forgot-password. - Submit your email (
POST /auth/password-reset/request). - Open the reset link.
- The reset page validates token (
GET /auth/password-reset). - Submit new password (
POST /auth/password-reset/consume).
Rules:
- New password must be at least 8 characters.
- Reset links are single-use and time-bound.
C. Confirm account email
- Open confirmation link from email.
- Page validates token (
GET /auth/confirm). - Select
Confirm email(POST /auth/confirm/consume).
If validation fails, request a fresh confirmation email.
D. Accept organization invitation
- Open
/invite/accept?token=.... - Review invitation preview (
GET /auth/invitations/preview). - Set password and optional display name.
- Submit acceptance (
POST /auth/invitations/accept).
Rules:
- Password must be at least 8 characters.
- Password and confirmation must match.
Expected result and verification checks
- Login grants access to authenticated pages.
- Reset flow allows login with the new password.
- Confirm flow marks email as confirmed.
- Invitation acceptance creates account access in the target organization.
Common issues and fixes
- Missing token error: use the latest link from email.
- OAuth button missing: provider is not configured in this environment.
- Invitation rejected: token may be expired/revoked; ask org admin to resend.
- Login denied after account changes: clear stale cookies and retry.