auth

Start a first-party sign-in (authorization code + PKCE)

Browser-facing, not meant to be called by anything but a user-agent. Validates the request and redirects to the Flowral app's own sign-in screen; once the person signs in and allows the connection there, the app redirects on to redirect_uri with a one-time code. POST /oauth/token's authorization_code grant exchanges it for a token. client_id must name a registered first-party client (currently flowral-vscode) and redirect_uri must be a loopback address it owns.

get/v1/oauth/authorize

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/oauth/authorize
  • Auth: none required

Query parameters

client_idstring required
redirect_uristring required

A loopback address, e.g. http://127.0.0.1:<port>/callback.

response_typestring required

Must be code.

code_challengestring required

PKCE, S256 of a code_verifier the client keeps.

code_challenge_methodstring required

Must be S256.

statestring
scopestring

Space-separated. Defaults to everything the signed-in person can do; naming scopes here can only narrow it.

Changes

No recorded changes to this operation across all 1 revision of this API.