Start an OAuth Login

GET

auth

oauth

{provider}

start

Begin an OAuth login (redirect to the provider)

curl --request GET \
  --url https://billing.example.com/auth/oauth/{provider}/start \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/auth/oauth/{provider}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/auth/oauth/{provider}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/auth/oauth/{provider}/start"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/auth/oauth/{provider}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Begins a social login. The server generates a CSRF state and a PKCE code verifier, binds them into a short-lived signed httpOnly cookie (recurso_oauth_state, scoped to /auth/oauth, valid for 10 minutes), and 302-redirects to the provider’s authorize URL. The provider later sends the browser back to GET /auth/oauth/{provider}/callback, which finishes the login. Navigate a browser to this URL — do not call it from a server, since the state cookie must land in the same browser that completes the callback. Check which providers are available first with GET /auth/oauth/providers.

Path Parameters

Parameter	Type	Required	Description
`provider`	string	Yes	The provider to log in with: `google` or `github`.

Example Request

curl -i https://api.recurso.dev/auth/oauth/google/start

Example Response

There is no response body. A successful call answers 302 Found with the provider’s authorize URL in Location and the state cookie in Set-Cookie:

HTTP/1.1 302 Found
Location: https://accounts.google.com/o/oauth2/v2/auth?client_id=...&code_challenge=...&code_challenge_method=S256&redirect_uri=https%3A%2F%2Fapi.recurso.dev%2Fauth%2Foauth%2Fgoogle%2Fcallback&response_type=code&scope=openid+email+profile&state=...
Set-Cookie: recurso_oauth_state=...; Path=/auth/oauth; Max-Age=600; HttpOnly; Secure; SameSite=Lax

Errors

Status	Code	When	Fix
`404`	`not_found`	`provider` is not `google`/`github`, or the provider’s client id and secret are not configured.	Check `GET /auth/oauth/providers` and only offer providers with `enabled: true`.
`500`	`internal_error`	The server could not generate the CSRF state.	Retry; if it persists, contact support.

Errors use the standard envelope — see Errors.

Authorizations

Authorization

string

header

required

Path Parameters

provider

enum<string>

required

Available options:

google,

github

Response

Redirect to the provider's authorize URL. Sets the state cookie.

Begin an OAuth login (redirect to the provider)

curl --request GET \
  --url https://billing.example.com/auth/oauth/{provider}/start \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/auth/oauth/{provider}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/auth/oauth/{provider}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/auth/oauth/{provider}/start"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/auth/oauth/{provider}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Path Parameters

Example Request

Example Response

Errors

Authorizations

Path Parameters

Response

​Path Parameters

​Example Request

​Example Response

​Errors

Authorizations

Path Parameters

Response

Path Parameters

Example Request

Example Response

Errors