Skip to content
SupaCloud Docs
Select themeSelect language

POST /settings/oauth/:provider/device/poll — exchange the pending device code for a token (the FE polls this at the GitHub-dictated interval until connected).

POST
/api/settings/oauth/{provider}/device/poll
curl --request POST \
  --url https://example.com/api/settings/oauth/example/device/poll \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "state": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
string

Device-code OAuth provider name (copilot)

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
state
required

The opaque handle returned by device/start.

string
Examplegenerated
{
  "state": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Poll outcome: pending / slow_down / connected (with the connection status)

Media typeapplication/json

The poll outcome: pending (keep polling at the interval), slow_down (back off), or connected (the connection status is set and the flow is complete).

object
connection
One of:
null
status
required
string
Examplegenerated
{
  "connection": {
    "account_email": "example",
    "connected": true,
    "consecutive_refresh_failures": 1,
    "expires_at": "2026-04-15T12:00:00Z",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "last_refresh_attempt_at": "2026-04-15T12:00:00Z",
    "notified_expiry_at": "2026-04-15T12:00:00Z",
    "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "provider": "example",
    "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  },
  "status": "example"
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}