Test a Federation Configuration End-to-End
curl --request POST \
--url https://use.hoop.dev/api/federation/test \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"hook_source": "builtin",
"admin_credentials_json": "<string>",
"builtin_provider": "gcp_iam",
"connection_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"created_at": "2025-05-25T17:00:00Z",
"extra_config": {},
"fallback_policy": "deny",
"has_admin_credentials": true,
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"identity_source_attribute": "$.user.email",
"identity_target_template": "{user.email}",
"token_ttl_seconds": 3600,
"updated_at": "2025-05-25T17:00:00Z"
},
"connection": {
"agent_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"command": [
"bq",
"query",
"--use_legacy_sql=false"
],
"test_script": "SELECT 1",
"envs": {},
"subtype": "bigquery",
"type": "database"
},
"user_email": "alice@example.com",
"user_id": "00000000-0000-0000-0000-000000000001"
}
'import requests
url = "https://use.hoop.dev/api/federation/test"
payload = {
"config": {
"hook_source": "builtin",
"admin_credentials_json": "<string>",
"builtin_provider": "gcp_iam",
"connection_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"created_at": "2025-05-25T17:00:00Z",
"extra_config": {},
"fallback_policy": "deny",
"has_admin_credentials": True,
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"identity_source_attribute": "$.user.email",
"identity_target_template": "{user.email}",
"token_ttl_seconds": 3600,
"updated_at": "2025-05-25T17:00:00Z"
},
"connection": {
"agent_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"command": ["bq", "query", "--use_legacy_sql=false"],
"test_script": "SELECT 1",
"envs": {},
"subtype": "bigquery",
"type": "database"
},
"user_email": "alice@example.com",
"user_id": "00000000-0000-0000-0000-000000000001"
}
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({
config: {
hook_source: 'builtin',
admin_credentials_json: '<string>',
builtin_provider: 'gcp_iam',
connection_id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
created_at: '2025-05-25T17:00:00Z',
extra_config: {},
fallback_policy: 'deny',
has_admin_credentials: true,
id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
identity_source_attribute: '$.user.email',
identity_target_template: '{user.email}',
token_ttl_seconds: 3600,
updated_at: '2025-05-25T17:00:00Z'
},
connection: {
agent_id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
command: ['bq', 'query', '--use_legacy_sql=false'],
test_script: 'SELECT 1',
envs: {},
subtype: 'bigquery',
type: 'database'
},
user_email: 'alice@example.com',
user_id: '00000000-0000-0000-0000-000000000001'
})
};
fetch('https://use.hoop.dev/api/federation/test', 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://use.hoop.dev/api/federation/test",
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([
'config' => [
'hook_source' => 'builtin',
'admin_credentials_json' => '<string>',
'builtin_provider' => 'gcp_iam',
'connection_id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'created_at' => '2025-05-25T17:00:00Z',
'extra_config' => [
],
'fallback_policy' => 'deny',
'has_admin_credentials' => true,
'id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'identity_source_attribute' => '$.user.email',
'identity_target_template' => '{user.email}',
'token_ttl_seconds' => 3600,
'updated_at' => '2025-05-25T17:00:00Z'
],
'connection' => [
'agent_id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'command' => [
'bq',
'query',
'--use_legacy_sql=false'
],
'test_script' => 'SELECT 1',
'envs' => [
],
'subtype' => 'bigquery',
'type' => 'database'
],
'user_email' => 'alice@example.com',
'user_id' => '00000000-0000-0000-0000-000000000001'
]),
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://use.hoop.dev/api/federation/test"
payload := strings.NewReader("{\n \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\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://use.hoop.dev/api/federation/test")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/federation/test")
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 \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\n}"
response = http.request(request)
puts response.read_body{
"admin_principal": "hoop-admin@proj.iam.gserviceaccount.com",
"env_var_keys": [
"HOOP_GCP_ACCESS_TOKEN",
"HOOP_GCP_TOKEN_EXPIRES_AT"
],
"error": "failed minting access token: permission denied",
"probe_output": "+---+\n| f0_ |\n+---+\n| 1 |\n+---+",
"probe_status": "success",
"resolved_principal": "alice@example.com",
"success": true,
"superseded_env_vars": [
"GOOGLE_APPLICATION_CREDENTIALS"
],
"token_expires_at": "2025-05-25T18:00:00Z"
}{
"message": "the error description"
}{
"message": "the error description"
}Federation
Test a Federation Configuration End-to-End
Resolves the candidate federation configuration against a synthetic user AND dispatches a one-shot smoke probe (the caller-supplied test_script, e.g. “SELECT 1”) to the agent identified in the request body. Persisted state is never read or written: the entire candidate connection + federation pair lives in the body. Returns the resolved principal, the env-var keys that were injected (values are never returned), and the agent-side stdout/stderr of the probe. Success requires both phases to succeed.
POST
/
federation
/
test
Test a Federation Configuration End-to-End
curl --request POST \
--url https://use.hoop.dev/api/federation/test \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"hook_source": "builtin",
"admin_credentials_json": "<string>",
"builtin_provider": "gcp_iam",
"connection_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"created_at": "2025-05-25T17:00:00Z",
"extra_config": {},
"fallback_policy": "deny",
"has_admin_credentials": true,
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"identity_source_attribute": "$.user.email",
"identity_target_template": "{user.email}",
"token_ttl_seconds": 3600,
"updated_at": "2025-05-25T17:00:00Z"
},
"connection": {
"agent_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"command": [
"bq",
"query",
"--use_legacy_sql=false"
],
"test_script": "SELECT 1",
"envs": {},
"subtype": "bigquery",
"type": "database"
},
"user_email": "alice@example.com",
"user_id": "00000000-0000-0000-0000-000000000001"
}
'import requests
url = "https://use.hoop.dev/api/federation/test"
payload = {
"config": {
"hook_source": "builtin",
"admin_credentials_json": "<string>",
"builtin_provider": "gcp_iam",
"connection_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"created_at": "2025-05-25T17:00:00Z",
"extra_config": {},
"fallback_policy": "deny",
"has_admin_credentials": True,
"id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"identity_source_attribute": "$.user.email",
"identity_target_template": "{user.email}",
"token_ttl_seconds": 3600,
"updated_at": "2025-05-25T17:00:00Z"
},
"connection": {
"agent_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
"command": ["bq", "query", "--use_legacy_sql=false"],
"test_script": "SELECT 1",
"envs": {},
"subtype": "bigquery",
"type": "database"
},
"user_email": "alice@example.com",
"user_id": "00000000-0000-0000-0000-000000000001"
}
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({
config: {
hook_source: 'builtin',
admin_credentials_json: '<string>',
builtin_provider: 'gcp_iam',
connection_id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
created_at: '2025-05-25T17:00:00Z',
extra_config: {},
fallback_policy: 'deny',
has_admin_credentials: true,
id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
identity_source_attribute: '$.user.email',
identity_target_template: '{user.email}',
token_ttl_seconds: 3600,
updated_at: '2025-05-25T17:00:00Z'
},
connection: {
agent_id: '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
command: ['bq', 'query', '--use_legacy_sql=false'],
test_script: 'SELECT 1',
envs: {},
subtype: 'bigquery',
type: 'database'
},
user_email: 'alice@example.com',
user_id: '00000000-0000-0000-0000-000000000001'
})
};
fetch('https://use.hoop.dev/api/federation/test', 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://use.hoop.dev/api/federation/test",
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([
'config' => [
'hook_source' => 'builtin',
'admin_credentials_json' => '<string>',
'builtin_provider' => 'gcp_iam',
'connection_id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'created_at' => '2025-05-25T17:00:00Z',
'extra_config' => [
],
'fallback_policy' => 'deny',
'has_admin_credentials' => true,
'id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'identity_source_attribute' => '$.user.email',
'identity_target_template' => '{user.email}',
'token_ttl_seconds' => 3600,
'updated_at' => '2025-05-25T17:00:00Z'
],
'connection' => [
'agent_id' => '15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7',
'command' => [
'bq',
'query',
'--use_legacy_sql=false'
],
'test_script' => 'SELECT 1',
'envs' => [
],
'subtype' => 'bigquery',
'type' => 'database'
],
'user_email' => 'alice@example.com',
'user_id' => '00000000-0000-0000-0000-000000000001'
]),
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://use.hoop.dev/api/federation/test"
payload := strings.NewReader("{\n \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\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://use.hoop.dev/api/federation/test")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/federation/test")
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 \"config\": {\n \"hook_source\": \"builtin\",\n \"admin_credentials_json\": \"<string>\",\n \"builtin_provider\": \"gcp_iam\",\n \"connection_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"created_at\": \"2025-05-25T17:00:00Z\",\n \"extra_config\": {},\n \"fallback_policy\": \"deny\",\n \"has_admin_credentials\": true,\n \"id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"identity_source_attribute\": \"$.user.email\",\n \"identity_target_template\": \"{user.email}\",\n \"token_ttl_seconds\": 3600,\n \"updated_at\": \"2025-05-25T17:00:00Z\"\n },\n \"connection\": {\n \"agent_id\": \"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7\",\n \"command\": [\n \"bq\",\n \"query\",\n \"--use_legacy_sql=false\"\n ],\n \"test_script\": \"SELECT 1\",\n \"envs\": {},\n \"subtype\": \"bigquery\",\n \"type\": \"database\"\n },\n \"user_email\": \"alice@example.com\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\"\n}"
response = http.request(request)
puts response.read_body{
"admin_principal": "hoop-admin@proj.iam.gserviceaccount.com",
"env_var_keys": [
"HOOP_GCP_ACCESS_TOKEN",
"HOOP_GCP_TOKEN_EXPIRES_AT"
],
"error": "failed minting access token: permission denied",
"probe_output": "+---+\n| f0_ |\n+---+\n| 1 |\n+---+",
"probe_status": "success",
"resolved_principal": "alice@example.com",
"success": true,
"superseded_env_vars": [
"GOOGLE_APPLICATION_CREDENTIALS"
],
"token_expires_at": "2025-05-25T18:00:00Z"
}{
"message": "the error description"
}{
"message": "the error description"
}Body
application/json
The request body resource
Config is the candidate federation configuration to test. Required. Carries the plaintext admin_credentials_json the resolver will use to authenticate; the value never reaches persistence on this endpoint.
Show child attributes
Show child attributes
Connection is the candidate connection the probe runs against. Required. The endpoint does NOT look up a persisted connection by name/id — the caller supplies the agent, command, script and envs directly so a wizard draft can be exercised before persistence.
Show child attributes
Show child attributes
UserEmail is the synthetic user to resolve. Required.
Example:
"alice@example.com"
UserID is the synthetic user ID. Optional; defaults to a deterministic UUID derived from UserEmail.
Example:
"00000000-0000-0000-0000-000000000001"
Response
OK
AdminPrincipal is the impersonator identity (e.g. admin SA email).
Example:
"hoop-admin@proj.iam.gserviceaccount.com"
EnvVarKeys lists the env vars the resolver injected into the probe. Values are never returned.
Example:
[
"HOOP_GCP_ACCESS_TOKEN",
"HOOP_GCP_TOKEN_EXPIRES_AT"
]
Error is the human-readable failure reason when Success=false. Populated for federation-resolve failures; probe-side failures are reported via ProbeStatus + ProbeOutput.
Example:
"failed minting access token: permission denied"
ProbeOutput is the agent's merged stdout+stderr from the smoke probe. Empty when ProbeStatus="skipped".
Example:
"+---+\n| f0_ |\n+---+\n| 1 |\n+---+"
ProbeStatus reports the agent-side outcome. "success" when exit code was 0; "failed" otherwise; "skipped" when federation resolve failed and the probe was not dispatched.
Available options:
success, failed, skipped Example:
"success"
ResolvedPrincipal is the principal the resolver impersonated.
Example:
"alice@example.com"
Success is true only when federation resolved AND the agent probe returned exit code 0.
Example:
true
SupersededEnvVars lists the candidate connection's static env var names that the provider's output supersedes and that were therefore stripped from the probe (and would be stripped from a real session). Lets the admin UI show "these legacy credentials were ignored" so the operator can confidently remove them from the persisted connection. Example: gcp_iam supersedes GOOGLE_APPLICATION_CREDENTIALS.
Example:
["GOOGLE_APPLICATION_CREDENTIALS"]
TokenExpiresAt is the would-be credential expiry.
Example:
"2025-05-25T18:00:00Z"
Was this page helpful?