TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.apiOAuth.upsertConfig({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"clientId": "<string>",
"clientSecret": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": true,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"ref": {
"apiAccessKeyId": "<string>",
"revision": 123
},
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
'import requests
url = "https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig"
payload = {
"clientId": "<string>",
"clientSecret": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": True,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"ref": {
"apiAccessKeyId": "<string>",
"revision": 123
},
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"tql_api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clientId: '<string>',
clientSecret: '<string>',
authUrl: '<string>',
tokenUrl: '<string>',
scopes: '<string>',
usePkce: true,
tokenAuthMethod: '<string>',
extraConfig: {},
ref: {apiAccessKeyId: '<string>', revision: 123},
authHeader: '<string>',
authPrefix: '<string>',
grantType: '<string>'
})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig', 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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig",
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([
'clientId' => '<string>',
'clientSecret' => '<string>',
'authUrl' => '<string>',
'tokenUrl' => '<string>',
'scopes' => '<string>',
'usePkce' => true,
'tokenAuthMethod' => '<string>',
'extraConfig' => [
],
'ref' => [
'apiAccessKeyId' => '<string>',
'revision' => 123
],
'authHeader' => '<string>',
'authPrefix' => '<string>',
'grantType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": "<string>",
"clientId": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": true,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"apiAccessKeyId": "<string>",
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
}{
"code": "not_found",
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Api O Auth Service
Upsert Api O Auth Config
Shared OAuth app configuration. Requires connector write permission.
POST
/
textql.rpc.public.api_oauth.ApiOAuthService
/
UpsertApiOAuthConfig
TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.apiOAuth.upsertConfig({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"clientId": "<string>",
"clientSecret": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": true,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"ref": {
"apiAccessKeyId": "<string>",
"revision": 123
},
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
'import requests
url = "https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig"
payload = {
"clientId": "<string>",
"clientSecret": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": True,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"ref": {
"apiAccessKeyId": "<string>",
"revision": 123
},
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"tql_api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clientId: '<string>',
clientSecret: '<string>',
authUrl: '<string>',
tokenUrl: '<string>',
scopes: '<string>',
usePkce: true,
tokenAuthMethod: '<string>',
extraConfig: {},
ref: {apiAccessKeyId: '<string>', revision: 123},
authHeader: '<string>',
authPrefix: '<string>',
grantType: '<string>'
})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig', 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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig",
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([
'clientId' => '<string>',
'clientSecret' => '<string>',
'authUrl' => '<string>',
'tokenUrl' => '<string>',
'scopes' => '<string>',
'usePkce' => true,
'tokenAuthMethod' => '<string>',
'extraConfig' => [
],
'ref' => [
'apiAccessKeyId' => '<string>',
'revision' => 123
],
'authHeader' => '<string>',
'authPrefix' => '<string>',
'grantType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
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://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.api_oauth.ApiOAuthService/UpsertApiOAuthConfig")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"authUrl\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"scopes\": \"<string>\",\n \"usePkce\": true,\n \"tokenAuthMethod\": \"<string>\",\n \"extraConfig\": {},\n \"ref\": {\n \"apiAccessKeyId\": \"<string>\",\n \"revision\": 123\n },\n \"authHeader\": \"<string>\",\n \"authPrefix\": \"<string>\",\n \"grantType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": "<string>",
"clientId": "<string>",
"authUrl": "<string>",
"tokenUrl": "<string>",
"scopes": "<string>",
"usePkce": true,
"tokenAuthMethod": "<string>",
"extraConfig": {},
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"apiAccessKeyId": "<string>",
"authHeader": "<string>",
"authPrefix": "<string>",
"grantType": "<string>"
}
}{
"code": "not_found",
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Authorizations
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"authorization_code" (default), "client_credentials", "jwt_bearer", or "device_code"
Response
Success
Show child attributes
Show child attributes