Create auth configuration
curl --request POST \
--url https://flowra.dev/api/v1/auth_configs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toolkit": {
"slug": "slack"
},
"authConfig": {
"type": "use_provider_managed_auth",
"displayName": "Gmail (managed)"
}
}
'import requests
url = "https://flowra.dev/api/v1/auth_configs"
payload = {
"toolkit": { "slug": "slack" },
"authConfig": {
"type": "use_provider_managed_auth",
"displayName": "Gmail (managed)"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toolkit: {slug: 'slack'},
authConfig: {type: 'use_provider_managed_auth', displayName: 'Gmail (managed)'}
})
};
fetch('https://flowra.dev/api/v1/auth_configs', 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://flowra.dev/api/v1/auth_configs",
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([
'toolkit' => [
'slug' => 'slack'
],
'authConfig' => [
'type' => 'use_provider_managed_auth',
'displayName' => 'Gmail (managed)'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://flowra.dev/api/v1/auth_configs"
payload := strings.NewReader("{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://flowra.dev/api/v1/auth_configs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/auth_configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"toolkit": {
"slug": "gmail"
},
"authConfig": {
"id": "auth_config_123",
"authScheme": "OAUTH2",
"provider": "LOCAL",
"externalId": "ac_gmail_abc123",
"isProviderManaged": true,
"restrictToFollowingTools": []
}
}
}Auth Configs
Create auth configuration
Create an authentication configuration (OAuth or API key) for a toolkit. Workflows and agents can then use this config to connect to the external service (e.g. Slack, CRM).
POST
/
api
/
v1
/
auth_configs
Create auth configuration
curl --request POST \
--url https://flowra.dev/api/v1/auth_configs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toolkit": {
"slug": "slack"
},
"authConfig": {
"type": "use_provider_managed_auth",
"displayName": "Gmail (managed)"
}
}
'import requests
url = "https://flowra.dev/api/v1/auth_configs"
payload = {
"toolkit": { "slug": "slack" },
"authConfig": {
"type": "use_provider_managed_auth",
"displayName": "Gmail (managed)"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toolkit: {slug: 'slack'},
authConfig: {type: 'use_provider_managed_auth', displayName: 'Gmail (managed)'}
})
};
fetch('https://flowra.dev/api/v1/auth_configs', 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://flowra.dev/api/v1/auth_configs",
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([
'toolkit' => [
'slug' => 'slack'
],
'authConfig' => [
'type' => 'use_provider_managed_auth',
'displayName' => 'Gmail (managed)'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://flowra.dev/api/v1/auth_configs"
payload := strings.NewReader("{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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://flowra.dev/api/v1/auth_configs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/auth_configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toolkit\": {\n \"slug\": \"slack\"\n },\n \"authConfig\": {\n \"type\": \"use_provider_managed_auth\",\n \"displayName\": \"Gmail (managed)\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"toolkit": {
"slug": "gmail"
},
"authConfig": {
"id": "auth_config_123",
"authScheme": "OAUTH2",
"provider": "LOCAL",
"externalId": "ac_gmail_abc123",
"isProviderManaged": true,
"restrictToFollowingTools": []
}
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Body
application/json
Auth configuration data
Response
200 - application/json
Auth config created successfully
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{
"toolkit": { "slug": "gmail" },
"authConfig": {
"id": "auth_config_123",
"authScheme": "OAUTH2",
"provider": "LOCAL",
"externalId": "ac_gmail_abc123",
"isProviderManaged": true,
"restrictToFollowingTools": []
}
}
Was this page helpful?