Oauth Setup Callback

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

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

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

auth

setup

{provider_id}

Oauth Setup Callback

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

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

provider_id

string

required

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

Successful Response

⌘I