Begin OAuth connection

Start an OAuth attempt and return the authorization details.

POST/api/integration/{integrationID}/connect/oauth

Path parameters

integrationIDstringrequired

Query parameters

locationobject | any

Request body

requiredapplication/json

methodIDstringrequired

inputsobjectrequired

labelstring | any

Show properties

Any of:

string

string

any

any

Responses

200Success

locationLocation.Inforequired

Show properties

directorystringrequired

workspaceIDobject

Show properties

object

projectobjectrequired

Show properties

idstringrequired

directorystringrequired

dataIntegration.Attemptrequired

Show properties

attemptIDstringrequired

urlstringrequired

instructionsstringrequired

modestringrequired

Allowed:autocode

timeobjectrequired

Show properties

creatednumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

expiresnumber | string | stringrequired

Show properties

Any of:

number | string

Any of:

number

number

string

string

string

string

string

string

string

string

400InvalidRequestError

Any of:

InvalidRequestError1

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X POST "/api/integration/string/connect/oauth" \
  -H "Content-Type: application/json" \
  -d '{
  "methodID": "string",
  "inputs": {},
  "label": "string"
}'

const response = await fetch("/api/integration/string/connect/oauth", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "methodID": "string",
  "inputs": {},
  "label": "string"
})
});

import requests

response = requests.post(
    "/api/integration/string/connect/oauth",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "methodID": "string",
  "inputs": {},
  "label": "string"
},
)

Response

{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": {
    "attemptID": "string",
    "url": "string",
    "instructions": "string",
    "mode": "auto",
    "time": {
      "created": 0,
      "expires": 0
    }
  }
}