Connections

List managed connections given the provided filters

Find managed connections by provider type and current state

🔒 Requires Connections: List Connections permission.

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 (ProviderTypeEnum)

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

402

You must upgrade your plan to use this feature

403

You are not allowed to perform this action

412

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

500

Internal server error

get/connections
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "1",
      • "clientType": "GOOGLE",
      • "state": "ACTIVE",
      • "connected": false,
      • "connectedAt": "2025-07-01T16:45:55.246Z",
      • "failedAt": "2025-07-01T16:45:55.246Z",
      • "clientId": "abc123",
      • "clientAlias": "My-connection-alias-1",
      • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
      • "deletedAt": "2025-07-01T16:45:55.246Z",
      • "providerTypes": [
        • {
          • "value": "MDM",
          • "isEnabled": true
          }
        ],
      • "code": 10010,
      • "groupLabel": "Everyone"
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}
Create an IdP connection with file
Create an IdP connection requires a file to complete the process


🔒 Requires Personnel: Import Personnel permission.


Securitybearer 
Responses 
201
401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


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


500
Internal server error


post/connections/upload/csv
Request samples 
Response samples 
application/json
{ }
update an IdP connection with file
Update an IdP connection that requires a file to complete the process


🔒 Requires Personnel: Import Personnel permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Responses 
200
401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


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


500
Internal server error


put/connections/{id}/upload/csv
Request samples 
Response samples 
application/json
{ }
Create an IdP connection with personnel list
Create an IdP connection that requires personnel list to complete the process


🔒 Requires Personnel: Import Personnel permission.


Securitybearer 
Request 
Request Body schema: application/json
required
required
Array of objects (PersonnelDataPublicDto) 
The list of personnel


 
Responses 
201
401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


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


500
Internal server error


post/connections/upload/json
Request samples 
application/json
{
  • "personnelData": [
    • {
      • "id": "233",
      • "firstName": "Neil",
      • "lastName": "Armstrong",
      • "email": "[email protected]",
      • "avatarUrl": "https://i.pravatar.cc/150?img=60",
      • "contractor": false,
      • "isMfaEnabled": true,
      • "jobTitle": "painter",
      • "customerId": "A232-23983",
      • "date": "2024-10-18T01:28:40"
      }
    ]
}
Response samples 
application/json
{ }
Update an IdP connection with personnel list
Update an IdP connection that requires personnel list to complete the process


🔒 Requires Personnel: Import Personnel permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
required
Array of objects (PersonnelDataPublicDto) 
The list of personnel


 
Responses 
200
401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


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


500
Internal server error


put/connections/{id}/upload/json
Request samples 
application/json
{
  • "personnelData": [
    • {
      • "id": "233",
      • "firstName": "Neil",
      • "lastName": "Armstrong",
      • "email": "[email protected]",
      • "avatarUrl": "https://i.pravatar.cc/150?img=60",
      • "contractor": false,
      • "isMfaEnabled": true,
      • "jobTitle": "painter",
      • "customerId": "A232-23983",
      • "date": "2024-10-18T01:28:40"
      }
    ]
}
Response samples 
application/json
{ }