Platform API reference

Platform API · Oauth-Authorization-Server

get/v1/oauth/authorize

OAuth 2.1 authorization endpoint

Requires PKCE with `code_challenge_method=S256`; a session that has been signed out counts as no session; `plain` and a missing challenge are both rejected. `redirect_uri` must match a registered URI exactly, with only the RFC 8252 §7.3 loopback port relaxation. Responds 302 either to sign-in (no session) or to the consent screen.

Query parameters

productsobject

Comma-separated products to pre-select on the consent screen (`auth`, `mail`, `waitlist`, `social`, `trawl`, `flags`, `notify`). A pre-selection only: the human decides. Unknown names are ignored.

resourceobject

RFC 8707 resource indicator. Becomes the access token `aud`. It may carry `?products=mail,waitlist`, which pre-selects products on the consent screen and is removed from the audience.

stateobject
code_challenge_method*object
code_challenge*object
scope*object

Space-delimited preset names (`readonly`, `mail`, `support`, `full`). A preset resolves to a policy template the human narrows on the consent screen; it is never authority in itself.

redirect_uri*object
client_id*object
response_type*object

Response · 302

Redirect to sign-in or to the consent screen.