Skip to main content
GET
/
api
/
iam
/
v1
Iam
curl --request GET \
  --url https://developer.synq.io/api/iam/v1 \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://developer.synq.io/api/iam/v1"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/iam/v1', 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://developer.synq.io/api/iam/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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://developer.synq.io/api/iam/v1"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/iam/v1")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/iam/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "workspace": "<string>",
  "scopes": [],
  "scopeNames": [
    "<string>"
  ],
  "integrationId": "<string>",
  "subject": "<string>",
  "synqUserId": "<string>",
  "clientType": "<string>",
  "userName": "<string>",
  "userEmail": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

workspace
string

Workspace to which caller is authenticated

scopes
enum<string>[]

What scopes are granted

Available options:
SCOPE_UNSPECIFIED,
SCOPE_ISSUES_EDIT,
SCOPE_ISSUES_READ,
SCOPE_INCIDENTS_EDIT,
SCOPE_INCIDENTS_READ,
SCOPE_ENTITY_EDIT,
SCOPE_ENTITY_READ,
SCOPE_ENTITY_TYPE_EDIT,
SCOPE_ENTITY_TYPE_READ,
SCOPE_LINEAGE_EDIT,
SCOPE_LINEAGE_READ,
SCOPE_CODE_READ,
SCOPE_STATUS_READ,
SCOPE_INGEST_DBT,
SCOPE_INGEST_SQLMESH,
SCOPE_INGEST_DWH,
SCOPE_INGEST_SRE,
SCOPE_INGEST_AIRFLOW,
SCOPE_INGEST_CLOUDWATCH,
SCOPE_INGEST_OPENLINEAGE,
SCOPE_DATACHECKS_SQLTESTS_EDIT,
SCOPE_DATACHECKS_SQLTESTS_READ,
SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ,
SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT,
SCOPE_DATACHECKS_TESTSUGGESTIONS_READ,
SCOPE_DATACHECKS_TRIGGER,
SCOPE_EXECUTION_EDIT,
SCOPE_EXECUTION_LOG_EDIT,
SCOPE_EXECUTION_READ,
SCOPE_HOOK,
SCOPE_SRE_AGENT,
SCOPE_SRE_LLM,
SCOPE_INTEGRATION_EDIT,
SCOPE_INTEGRATION_READ,
SCOPE_USER_EDIT,
SCOPE_USER_READ,
SCOPE_USER_ASSIGN,
SCOPE_MONITORS_READ,
SCOPE_MONITORS_AUTOMATIC_EDIT,
SCOPE_MONITORS_CUSTOM_EDIT,
SCOPE_MONITORS_CUSTOM_SQL_EDIT,
SCOPE_ALERTS_EDIT,
SCOPE_ALERTS_READ,
SCOPE_DATAPRODUCT_EDIT,
SCOPE_DATAPRODUCT_READ,
SCOPE_DOMAIN_EDIT,
SCOPE_DOMAIN_READ,
SCOPE_EXTENSIONS_MANAGE,
SCOPE_USAGE_GET,
SCOPE_MCP_READ,
SCOPE_MCP_WRITE,
SCOPE_RECON_READ,
SCOPE_RECON_EDIT,
SCOPE_INGEST_RECON,
SCOPE_RECON_PROMOTE,
SCOPE_POLICIES_EDIT,
SCOPE_POLICIES_READ,
SCOPE_SAVED_VIEW_READ,
SCOPE_SAVED_VIEW_EDIT,
SCOPE_SAVED_VIEW_ADMIN
scopeNames
string[]

Names of the scopes available

integrationId
string | null

Indicates that the token is scoped to a specific integration

subject
string

Identifier of the provided token

synqUserId
string | null

Coalesce Quality user ID associated with the token, present for user-level credentials

clientType
string | null

Indicates the client type through which the request was made

userName
string | null

Human-readable name of the authenticated user. Populated only when the token is tied to a Coalesce Quality user (i.e. synq_user_id is set); empty for workspace-level or third-party tokens.

userEmail
string | null

Email address of the authenticated user. Populated only when the token is tied to a Coalesce Quality user (i.e. synq_user_id is set); empty for workspace-level or third-party tokens.