Skip to main content
GET
/
api
/
iam
/
v1
Iam
curl --request GET \
  --url https://developer.synq.io/api/iam/v1 \
  --header 'Authorization: Bearer <token>'
{
  "workspace": "<string>",
  "scopes": [
    "SCOPE_UNSPECIFIED"
  ],
  "scopeNames": [
    "<string>"
  ],
  "integrationId": "<string>",
  "subject": "<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_USER_EDIT,
SCOPE_USER_READ,
SCOPE_USER_ASSIGN,
SCOPE_MONITORS_READ,
SCOPE_MONITORS_AUTOMATIC_EDIT,
SCOPE_MONITORS_CUSTOM_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
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