Start authorization flow

GET https://api.light.inc/oauth/authorize

Redirects the user to the authorization page to start the OAuth V2 authorization flow

This endpoint does not return JSON. It answers 303 See Other with an empty body and a Location header pointing at Light's identity provider, so send the user's browser here rather than calling it from a server. client_id and redirect_uri are required; state is optional and echoed back unchanged on the callback. The scope is fixed by Light (openid profile email offline_access) and the user is always shown the login and consent screens; PKCE (code_challenge) is not supported and any scope you pass is ignored.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Query parameters

redirect_uri string
state string
client_id string

Response

This endpoint returns no content.

curl -X GET "https://api.light.inc/oauth/authorize" \
  -H "Authorization: Basic YOUR_API_KEY"

const res = await fetch("https://api.light.inc/oauth/authorize", {
  method: "GET",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.light.inc/oauth/authorize",
    headers={"Authorization": f"Basic {os.environ['LIGHT_API_KEY']}"},
)
data = res.json()