Skip to content

Start a sign-in with Google or GitHub

GET
/v1/auth/oauth/{provider}/start
curl --request GET \
--url 'https://beta-api.plune.ai/v1/auth/oauth/google/start?return=%2Fsignup'

Where «Continue with Google» and «Continue with GitHub» on the sign-in screen lead (#2534). Sets a signed, HttpOnly cookie (__Host-plune_oauth over https, SameSite=Lax, path /, ten minutes) holding a random state and the PKCE verifier, and redirects (302) to the provider with the state and an S256 code_challenge. return is the page a refusal comes back to: a path on the web app (/signup?utm_source=…); anything else (another origin, //host, a backslash) is ignored and the refusal lands on /login. 404 for a provider other than google or github, and for one whose OAuth app is not configured (GET /health lists the configured ones in providers). 20 starts in 15 minutes from one client address. Sent with Cache-Control: no-store and Referrer-Policy: no-referrer.

provider
required
string
Allowed values: google github
return
string
Example
/signup

A path on the web app a refusal lands on; default /login.

To the provider’s consent page

Location
string

Unknown provider, or its OAuth app is not configured

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited by the client IP (20 in 15 minutes). error names the limit and the wait.

Retry-After
integer

Seconds until the window rolls over