Start connecting a connection by OAuth: the platform's consent page to send your browser to, and its state, good for 10 minutes; redirect_uri is one of connectors' registered pages: your workspace's owner

POST

/v1/buyer/connections/{id}/oauth

curl --request POST \
  --url https://example.com/v1/buyer/connections/example/oauth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "redirect_uri": "example" }'

Who: a workspace’s owner. Not for API keys.

Authorizations

• bearer

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

redirect_uri

required

string

Example ^generated

{
  "redirect_uri": "example"
}

Responses

200

OK

Media typeapplication/json

object

authorization_url

required

string

state

required

string

Example ^generated

{
  "authorization_url": "example",
  "state": "example"
}

default

An error, as go-commons apperr maps it

Media typeapplication/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}