Platform API reference

Platform API · OAuth Sign-In

get/v1/auth/oauth/{provider}/start

Begin a federated sign-in flow; 302s to the provider authorize URL.

Path parameters

provider*enum (3)

OAuth provider id. Providers are gated on env-var configuration; unconfigured providers 400 with UNKNOWN_OAUTH_PROVIDER.

Query parameters

return_to*string

Absolute URL the user lands on after a successful signin. Must match the `OAUTH_RETURN_TO_ORIGINS` allowlist (CSV, wildcards supported as `https://*.productcraft.co`).

Response · 302

Redirect to provider authorize URL.