Create integration credentials

curl --request POST \
  --url https://flows.super.ai/api/integrations/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "credentials": {},
  "name": "<string>"
}
'

import requests

url = "https://flows.super.ai/api/integrations/credentials"

payload = {
    "credentials": {},
    "name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({credentials: {}, name: '<string>'})
};

fetch('https://flows.super.ai/api/integrations/credentials', 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://flows.super.ai/api/integrations/credentials",
  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([
    'credentials' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://flows.super.ai/api/integrations/credentials"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://flows.super.ai/api/integrations/credentials")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/integrations/credentials")

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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

integrations

Create integration credentials

Create new integration credentials for connecting to external services.

Stores encrypted credentials for connecting to third-party services like Google Drive, SharePoint, SFTP servers, or PostgreSQL databases. Credentials are encrypted at rest using AES-256-GCM and scoped to the user’s organization for security isolation.

Context: This endpoint is the primary mechanism for establishing connections to external integrations. After credentials are created, they can be used in:

Flow tasks that require external data sources (file inputs, database queries)
Webhook subscriptions for real-time data synchronization
Batch data imports from cloud storage providers
Database query operations within workflow executions
OAuth-based integrations (after completing OAuth flow first)

Credentials are never stored in plaintext and cannot be retrieved after creation. For OAuth providers (Google, SharePoint), complete the authorization flow first, then the callback handler automatically creates credentials.

Use Cases: Create SFTP credentials for connecting to a file server to download CSV files in a workflow.

Store PostgreSQL database credentials to enable SQL query tasks in flows.

After testing connection with POST /integrations/sftp/test-connection, create permanent credentials. Related Endpoints:

POST /integrations/sftp/test-connection - Test SFTP credentials before saving
POST /integrations/postgres/test-connection - Test PostgreSQL credentials before saving
GET /integrations/google/authorize - Initiate Google OAuth flow
GET /integrations/sharepoint/authorize - Initiate SharePoint OAuth flow
GET /integrations/credentials - List all user credentials
GET /integrations/credentials/ - Get specific credential metadata
DELETE /integrations/credentials/ - Delete credential
PATCH /integrations/credentials/ - Update credential

Security:

Credentials are encrypted using Fernet (AES-256-GCM) before database storage
Encryption keys are managed via environment variables and never exposed via API
Passwords, private keys, and tokens are never logged or included in API responses
Credentials are scoped to organization with strict isolation enforced at query level
OAuth tokens are automatically refreshed when expired (no user action required)
Audit trail: Created timestamps and user associations tracked for compliance

Notes:

Always test credentials before creating them (use test-connection endpoints)
OAuth credentials require completing the OAuth authorization flow first
Maximum 50 credentials per provider per organization (contact support for higher limits)
Credentials cannot be retrieved in plaintext after creation (security by design)
For SFTP key_file authentication, ensure private key is in valid PEM format
PostgreSQL connection_string takes precedence over individual connection fields

POST

api

integrations

credentials

Create integration credentials

curl --request POST \
  --url https://flows.super.ai/api/integrations/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "credentials": {},
  "name": "<string>"
}
'

import requests

url = "https://flows.super.ai/api/integrations/credentials"

payload = {
    "credentials": {},
    "name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "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>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({credentials: {}, name: '<string>'})
};

fetch('https://flows.super.ai/api/integrations/credentials', 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://flows.super.ai/api/integrations/credentials",
  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([
    'credentials' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://flows.super.ai/api/integrations/credentials"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://flows.super.ai/api/integrations/credentials")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/integrations/credentials")

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["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Body

application/json

Request model for creating user integration credentials

credential_type

enum<string>

required

Available options:

api_key,

oauth2,

user_password,

key_file,

client_credentials,

sharepoint_receive,

google_drive_receive

credentials

Credentials · object

required

name

string

required

provider

enum<string>

required

Available options:

microsoft,

sftp,

aws_ses,

google,

postgresql,

internal_postgresql,

file_storage,

sharepoint_client_secret

Response

Credentials created successfully

created_at

string<date-time>

required

string<uuid>

required

modified_by

string

required

name

string

required

provider

enum<string>

required

Available options:

microsoft,

sftp,

aws_ses,

google,

postgresql,

internal_postgresql,

file_storage,

sharepoint_client_secret

updated_at

string<date-time>

required

user_id

string<uuid> | null

List user credentials List credentials by provider