Oauth Setup Callback

Handle OAuth setup callback redirect from GitHub Apps.

This endpoint handles the “Setup URL” callback from GitHub Apps, which is triggered when a user installs or updates their GitHub App installation.

For “update” actions (user modified repo access via GitHub), we just show a success page since no token exchange is needed.

For new installations with code/state, we process similar to the regular OAuth callback.

GET /v2/auth/setup/{provider_id}

Oauth Setup Callback

cURL

curl --request GET \
  --url https://api.example.com/v2/auth/setup/{provider_id}

import requests

url = "https://api.example.com/v2/auth/setup/{provider_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v2/auth/setup/{provider_id}', 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://api.example.com/v2/auth/setup/{provider_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/v2/auth/setup/{provider_id}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v2/auth/setup/{provider_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/auth/setup/{provider_id}")

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

request = Net::HTTP::Get.new(url)

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

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

provider_id · string · required

Query Parameters

code · string

Authorization code from OAuth provider

state · string

State parameter containing auth_id

setup_action · string

Setup action from GitHub App

installation_id · integer

GitHub App installation ID

error · string

Error code from OAuth provider

error_description · string

Error description from OAuth provider

Response

200

application/json

Successful Response