Begin OAuth connection
curl --request POST \
--url https://api.example.com/api/integration/{integrationID}/connect/oauth \
--header 'Content-Type: application/json' \
--data '
{
"methodID": "<string>",
"inputs": {},
"label": "<string>"
}
'import requests
url = "https://api.example.com/api/integration/{integrationID}/connect/oauth"
payload = {
"methodID": "<string>",
"inputs": {},
"label": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({methodID: '<string>', inputs: {}, label: '<string>'})
};
fetch('https://api.example.com/api/integration/{integrationID}/connect/oauth', 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/api/integration/{integrationID}/connect/oauth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'methodID' => '<string>',
'inputs' => [
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/integration/{integrationID}/connect/oauth"
payload := strings.NewReader("{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/integration/{integrationID}/connect/oauth")
.header("Content-Type", "application/json")
.body("{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/integration/{integrationID}/connect/oauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"location": {
"directory": "<string>",
"project": {
"id": "<string>",
"directory": "<string>"
},
"workspaceID": "<string>"
},
"data": {
"attemptID": "<string>",
"url": "<string>",
"instructions": "<string>",
"time": {
"created": 123,
"expires": 123
}
}
}{
"_tag": "InvalidRequestError",
"message": "<string>",
"kind": "<string>",
"field": "<string>"
}{
"_tag": "UnauthorizedError",
"message": "<string>"
}integration
Begin OAuth connection
Start an OAuth attempt and return the authorization details.
POST
/
api
/
integration
/
{integrationID}
/
connect
/
oauth
Begin OAuth connection
curl --request POST \
--url https://api.example.com/api/integration/{integrationID}/connect/oauth \
--header 'Content-Type: application/json' \
--data '
{
"methodID": "<string>",
"inputs": {},
"label": "<string>"
}
'import requests
url = "https://api.example.com/api/integration/{integrationID}/connect/oauth"
payload = {
"methodID": "<string>",
"inputs": {},
"label": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({methodID: '<string>', inputs: {}, label: '<string>'})
};
fetch('https://api.example.com/api/integration/{integrationID}/connect/oauth', 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/api/integration/{integrationID}/connect/oauth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'methodID' => '<string>',
'inputs' => [
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/integration/{integrationID}/connect/oauth"
payload := strings.NewReader("{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/integration/{integrationID}/connect/oauth")
.header("Content-Type", "application/json")
.body("{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/integration/{integrationID}/connect/oauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"methodID\": \"<string>\",\n \"inputs\": {},\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"location": {
"directory": "<string>",
"project": {
"id": "<string>",
"directory": "<string>"
},
"workspaceID": "<string>"
},
"data": {
"attemptID": "<string>",
"url": "<string>",
"instructions": "<string>",
"time": {
"created": 123,
"expires": 123
}
}
}{
"_tag": "InvalidRequestError",
"message": "<string>",
"kind": "<string>",
"field": "<string>"
}{
"_tag": "UnauthorizedError",
"message": "<string>"
}Path Parameters
Query Parameters
Show child attributes
Show child attributes
Body
application/json
⌘I