List managed connections given the provided filters

Find managed connections by provider type and current state

Securitybearer
Request
query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

sort
string

Which type of sort (default: CREATED)

Enum: "CREATED_AT" "CONNECTED_AT" "CONNECTION_PROVIDER_TYPE" "CONNECTION_CLIENT_TYPE" "CONNECTION_STATE"
sortDir
string

Which direction to sort the data (default: ASC)

Enum: "ASC" "DESC"
providerTypes
Array of strings

Connection provider types

Items Enum: "IDENTITY" "INFRASTRUCTURE" "VERSION_CONTROL" "TICKETING" "HRIS" "BACKGROUND_CHECK" "SINGLE_SIGN_ON" "ENTERPRISE_SSO" "MDM" "SECURITY_TRAINING" "OBSERVABILITY" "COMMUNICATION" "DIGITAL_SIGNATURE" "EXTERNAL_POLICY" "VULNERABILITY" "EDR" "USER_ACCESS_REVIEW" "CSPM" "CODEBASE" "CYBER_INSURANCE" "CRM" "CUSTOM"
state
string

Connection current state

Enum: "ACTIVE" "MISCONFIGURED" "CONFIGURED_PENDING_CONFIRMATION" "IN_PROGRESS"
Responses
200
401

Invalid Authorization

403

You are not allowed to perform this action

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

get/connections
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "1",
      • "clientType": "GOOGLE",
      • "state": "ACTIVE",
      • "connected": false,
      • "connectedAt": "2020-07-06 12:00:00.000000",
      • "failedAt": "2020-07-06 12:00:00.000000",
      • "companyId": "12341234",
      • "assignmentId": "FLk12AsS",
      • "user": {
        • "id": 1,
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2020-07-06 12:00:00.000000",
        • "createdAt": "2020-07-06 12:00:00.000000",
        • "updatedAt": "2020-07-06 12:00:00.000000",
        • "roles": [
          • "ROLE",
          • "ANOTHER_ROLE"
          ],
        • "backgroundChecks": [
          • {
            • "id": 1,
            • "userId": 1,
            • "status": "OK",
            • "caseId": "abc123",
            • "caseInvitationId": "abc123",
            • "url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
            • "manualCheckDate": "2020-07-06",
            • "manuallyCheckUrl": "url.com",
            • "type": "CERTN",
            • "source": "DRATA",
            • "reportData": "string",
            • "user": { },
            • "outOfScopeReason": "abc123",
            • "outOfScopeAt": "2020-07-06 12:00:00.000000",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2020-07-06 12:00:00.000000",
            • "createdAt": "2020-07-06 12:00:00.000000",
            • "updatedAt": "2020-07-06 12:00:00.000000"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2020-07-06 12:00:00.000000",
            • "disconnectedAt": "2020-07-06 12:00:00.000000",
            • "hasMfa": true,
            • "user": { },
            • "connection": { },
            • "hasIdp": true
            }
          ]
        },
      • "accountId": "string",
      • "clientId": "drata.com",
      • "clientAlias": "My-connection-alias-1",
      • "manuallyUpdatedAt": "2020-07-06 12:00:00.000000",
      • "aliasUpdatedAt": "2020-07-06 12:00:00.000000",
      • "deletedAt": "2020-07-06 12:00:00.000000",
      • "requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
      • "product": "",
      • "writeAccessEnabled": false,
      • "sourcePreference": "LABEL",
      • "securityLabel": "Jira Security Label",
      • "jqlQuery": "project = IT AND type = \"Offboarding\"",
      • "authorized": true,
      • "workspaces": [],
      • "providerTypes": [
        • 5
        ],
      • "code": 10010,
      • "groupLabel": "Everyone"
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}