Get Federation Configuration for a Connection
curl --request GET \
--url https://use.hoop.dev/api/connections/{nameOrID}/federationimport requests
url = "https://use.hoop.dev/api/connections/{nameOrID}/federation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/connections/{nameOrID}/federation', 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/connections/{nameOrID}/federation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/connections/{nameOrID}/federation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/connections/{nameOrID}/federation")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/connections/{nameOrID}/federation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "the error description"
}{
"message": "the error description"
}Connections
Get Federation Configuration for a Connection
Returns the IAM federation configuration for a connection. The admin credentials are never returned in plaintext; only a presence indicator is included.
GET
/
connections
/
{nameOrID}
/
federation
Get Federation Configuration for a Connection
curl --request GET \
--url https://use.hoop.dev/api/connections/{nameOrID}/federationimport requests
url = "https://use.hoop.dev/api/connections/{nameOrID}/federation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/connections/{nameOrID}/federation', 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/connections/{nameOrID}/federation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://use.hoop.dev/api/connections/{nameOrID}/federation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/connections/{nameOrID}/federation")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/connections/{nameOrID}/federation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "the error description"
}{
"message": "the error description"
}Response
OK
AdminCredentialsJSON is the plaintext admin credential blob. Its shape is provider-specific: for gcp_iam it is the admin service-account JSON; for gcp_oauth it is the OAuth client config JSON ({"client_id":"...", "client_secret":"..."}). Write-only — never returned on GET. Required on the initial POST when HookSource=builtin; optional on PUT (omitting it leaves the stored value unchanged).
Was this page helpful?