Integrations

Use the Integrations query to monitor the integrations connected to your organization. The query returns the current connection status and provider-specific configuration details for each integration.

Use this query to monitor integration health programmatically, build alerting on failed connections, or audit which accounts are in scope for a given integration.

List integrations by type

📘

Note

  • You must have Administrator role permissions to run this command.
  • IncludedScopeRawIds and ExcludedScopeRawIds reflect the scope configuration you set in the Console, in the Configure Scopes step of relevant integration wizards. The values are either individual account IDs or folder IDs. When all accounts in a folder are selected, the API returns the folder ID rather than listing each account individually.
    The Scopes step with Include specific folders and projects selected
query {
  Integrations(filter: {Types: [AwsOrganization, AzureSubscriptionIntegration]}) {
    nodes {
      Id
      Name
      Status
      Issues
      ... on OrganizationIntegration {
        IncludedScopeRawIds
        ExcludedScopeRawIds
        Accounts {
          Name
        }
      }
      ... on AzureSubscriptionIntegration {
        Account {
          ... on AzureSubscription {
            ServicePrincipalId
          }
        }
      }
    }
  }
}

Sample response

{
  "data": {
    "Integrations": {
      "nodes": [
        {
          "Id": "964dc6ce-0ffb-4a4f-8b62-5db1a8289d55",
          "Name": "Org1Subscription1",
          "Status": "Connected",
          "Issues": [],
          "Account": {
            "ServicePrincipalId": "259c4fb8-a82e-497a-8c33-bd847781c196"
          }
        },
        {
          "Id": "aeedba5c-9fb5-4b90-8d35-2ab96b70f1ec",
          "Name": "QA-Subscription",
          "Status": "Connected",
          "Issues": [],
          "Account": {
            "ServicePrincipalId": "259c4fb8-a82e-497a-8c33-bd847781c196"
          }
        }
      ]
    }
  }
}

Did this page help you?