Auth API reference

Auth API · Consumer-Oauth-Sign-In

get/{app_slug}/v1/auth/oauth/{provider}/authorize

Start the web redirect flow. 302s to the upstream provider with a server-generated state + nonce.

Path parameters

app_slug*string

Slug of the app.

provider*enum (3)

The sign-in provider: `google`, `github` or `apple`.

Query parameters

return_to*string

Absolute URL the customer wants the user redirected to after sign-in. Its origin MUST be in the app's `allowed_redirect_origins`. The full URL (including query + hash) is preserved; we append `?heimdall_code=<code>`.

sign_in_teststring · uuid

Try sign-in only: the id of a sign-in test created with `POST /v1/apps/{appId}/sign-in-tests`. The link from that response (`start_url`) carries it. With it, `return_to` must be exactly the console result page stored on the test, the link works once and for 10 minutes, and the round trip creates no account and issues no token: the result is recorded on the test.

Response · 302

Redirect to provider authorize URL (or, for a sign-in test that already failed its checks, to the console result page).