User Identities

Find infrastructure user identities

List infrastructure user identities by username or email

🔒 Requires Connections: Manage Infrastructure User Identities 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

q
string

Filter data by searching for identity id, username or email

Example: q=1a2b3c
clientType
string

The target client type

Enum: "AWS" "AWS_GOV_CLOUD" "DIGITAL_OCEAN" "GCP" "HEROKU" "AZURE" "AZURE_ORG_UNITS" "MONGO_DB_ATLAS" "CLOUDFLARE" "AWS_ORG_UNITS"
Example: clientType=AWS
connectionId
number

The target connection id (more granular than client type)

Example: connectionId=1
sort
string

Which type of sort (default: USERNAME)

Enum: "IDENTITY_ID" "USERNAME" "EMAIL" "CONNECTED_AT" "DISCONNECTED_AT" "SERVICE_ACCOUNT" "HAS_MFA" "ADMIN_ACCESS" "DB_ACCESS" "USER" "CLIENT_ID" "CLIENT_ALIAS" "CONNECTION_STATUS"
Example: sort=USERNAME
sortDir
string

Which direction to sort the data (default: ASC)

Enum: "ASC" "DESC"
Example: sortDir=ASC
Responses
200
400

Malformed data and/or validation errors

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/user-identities/infrastructure
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "identityId": "1a2b3c",
      • "username": "Username",
      • "email": "[email protected]",
      • "connectedAt": "2025-07-01T16:45:55.246Z",
      • "disconnectedAt": "2025-07-01T16:45:55.246Z",
      • "serviceAccount": "2025-07-01T16:45:55.246Z",
      • "serviceAccountReason": "This user is used to deploy code",
      • "user": {
        • "id": 1,
        • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z",
        • "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": "2025-07-01T16:45:55.246Z",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2025-07-01T16:45:55.246Z",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2025-07-01T16:45:55.246Z",
            • "disconnectedAt": "2025-07-01T16:45:55.246Z",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "failedAt": "2025-07-01T16:45:55.246Z",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "abc123",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "deletedAt": "2025-07-01T16:45:55.246Z",
              • "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"
              },
            • "hasIdp": true,
            • "secondaryEmail": "[email protected]",
            • "firstName": "John",
            • "lastName": "Doe",
            • "startedAt": "2025-07-01T16:45:55.246Z",
            • "separatedAt": "2025-07-01T16:45:55.246Z",
            • "isContractor": true,
            • "jobTitle": "Engineer",
            • "managerId": "x00jk12-2312",
            • "managerName": "string"
            }
          ],
        • "documents": [
          • {
            • "data": [
              • {
                • "id": null,
                • "name": null,
                • "type": null,
                • "fileUrl": null,
                • "renewalDate": null,
                • "createdAt": null,
                • "updatedAt": null
                }
              ],
            • "page": 1,
            • "limit": 10,
            • "total": 100
            }
          ]
        },
      • "serviceAccountDesignator": {
        • "id": 1,
        • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z",
        • "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": "2025-07-01T16:45:55.246Z",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2025-07-01T16:45:55.246Z",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2025-07-01T16:45:55.246Z",
            • "disconnectedAt": "2025-07-01T16:45:55.246Z",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "failedAt": "2025-07-01T16:45:55.246Z",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "abc123",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "deletedAt": "2025-07-01T16:45:55.246Z",
              • "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"
              },
            • "hasIdp": true,
            • "secondaryEmail": "[email protected]",
            • "firstName": "John",
            • "lastName": "Doe",
            • "startedAt": "2025-07-01T16:45:55.246Z",
            • "separatedAt": "2025-07-01T16:45:55.246Z",
            • "isContractor": true,
            • "jobTitle": "Engineer",
            • "managerId": "x00jk12-2312",
            • "managerName": "string"
            }
          ],
        • "documents": [
          • {
            • "data": [
              • {
                • "id": null,
                • "name": null,
                • "type": null,
                • "fileUrl": null,
                • "renewalDate": null,
                • "createdAt": null,
                • "updatedAt": null
                }
              ],
            • "page": 1,
            • "limit": 10,
            • "total": 100
            }
          ]
        },
      • "hasMfa": true,
      • "connection": {
        • "id": "1",
        • "clientType": "GOOGLE",
        • "state": "ACTIVE",
        • "connected": false,
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "failedAt": "2025-07-01T16:45:55.246Z",
        • "companyId": "12341234",
        • "assignmentId": "FLk12AsS",
        • "user": {
          • "id": 1,
          • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
          • "email": "[email protected]",
          • "firstName": "Sally",
          • "lastName": "Smith",
          • "jobTitle": "CEO",
          • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
          • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z",
          • "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": "2025-07-01T16:45:55.246Z",
              • "invitationEmail": "[email protected]",
              • "linkedAt": "2025-07-01T16:45:55.246Z",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "identities": [
            • {
              • "id": 1,
              • "identityId": "1a2b3c",
              • "username": "Username",
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "disconnectedAt": "2025-07-01T16:45:55.246Z",
              • "hasMfa": true,
              • "user": { },
              • "connection": { },
              • "hasIdp": true,
              • "secondaryEmail": "[email protected]",
              • "firstName": "John",
              • "lastName": "Doe",
              • "startedAt": "2025-07-01T16:45:55.246Z",
              • "separatedAt": "2025-07-01T16:45:55.246Z",
              • "isContractor": true,
              • "jobTitle": "Engineer",
              • "managerId": "x00jk12-2312",
              • "managerName": "string"
              }
            ],
          • "documents": [
            • {
              • "data": [
                • null
                ],
              • "page": 1,
              • "limit": 10,
              • "total": 100
              }
            ]
          },
        • "accountId": "string",
        • "clientId": "abc123",
        • "clientAlias": "My-connection-alias-1",
        • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
        • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
        • "deletedAt": "2025-07-01T16:45:55.246Z",
        • "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"
        },
      • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "adminAccess": "2025-07-01T16:45:55.246Z",
      • "dbAccess": "2025-07-01T16:45:55.246Z"
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}
Update infrastructure user identity connection status
Update the connection status for the target infrastructure user identity


🔒 Requires Connections: Manage Infrastructure User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
userId
required
number or null
The desired user id to link or null to unlink


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/infrastructure/{id}/connect
Request samples 
application/json
{
  • "userId": 1
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "adminAccess": "2025-07-01T16:45:55.246Z",
  • "dbAccess": "2025-07-01T16:45:55.246Z"
}
Update target infrastructure user identity toggle settings
Update the toggle setting for the target infrastructure user identity


🔒 Requires Connections: Manage Infrastructure User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
toggle
required
boolean
Toggle value for the setting


 
toggleField
string
The toggle field type to update


 Enum: "INFRASTRUCTURE_ADMIN_ACCESS" "INFRASTRUCTURE_DB_ACCESS"  
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/infrastructure/{id}/toggle
Request samples 
application/json
{
  • "toggle": true,
  • "toggleField": "INFRASTRUCTURE_ADMIN_ACCESS"
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "adminAccess": "2025-07-01T16:45:55.246Z",
  • "dbAccess": "2025-07-01T16:45:55.246Z"
}
Update infrastructure user identity to a service account
Update the target infrastructure user identity to a service account


🔒 Requires Connections: Manage Infrastructure User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
serviceAccount
required
boolean
Determines service account state


 
serviceAccountReason
required
string  <= 30000 characters 
Reason why this account is being marked as a service account


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/infrastructure/{id}/service-account
Request samples 
application/json
{
  • "serviceAccount": true,
  • "serviceAccountReason": "This account is used to deploy"
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "adminAccess": "2025-07-01T16:45:55.246Z",
  • "dbAccess": "2025-07-01T16:45:55.246Z"
}
Find version control user identities
List user version control identities for the target client type.


🔒 Requires Connections: Manage Version Control User Identities 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


 
q
string
Filter data by searching for identity id, username or email


 
 Example:  q=1a2b3c
clientType
string
The target client type


 Enum: "BITBUCKET" "GITHUB" "GITHUB_ENTERPRISE" "GITLAB" "GITLAB_ON_PREM" "AZURE_REPOS" "AWS_CODECOMMIT"  
 Example:  clientType=GITHUB
connectionId
number
The target connection id (more granular than client type)


 
 Example:  connectionId=1
sort
string
Which type of sort (default: USERNAME)


 Enum: "IDENTITY_ID" "USERNAME" "EMAIL" "CONNECTED_AT" "DISCONNECTED_AT" "SERVICE_ACCOUNT" "HAS_MFA" "WRITE_ACCESS" "PUSH_PROD_CODE_ACCESS" "USER" "CLIENT_ID" "CONNECTION_STATUS"  
 Example:  sort=USERNAME
sortDir
string
Which direction to sort the data (default: ASC)


 Enum: "ASC" "DESC"  
 Example:  sortDir=ASC
Responses 
200
400
Malformed data and/or validation errors


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/user-identities/version-control
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "identityId": "1a2b3c",
      • "username": "Username",
      • "email": "[email protected]",
      • "connectedAt": "2025-07-01T16:45:55.246Z",
      • "disconnectedAt": "2025-07-01T16:45:55.246Z",
      • "serviceAccount": "2025-07-01T16:45:55.246Z",
      • "serviceAccountReason": "This user is used to deploy code",
      • "user": {
        • "id": 1,
        • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z",
        • "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": "2025-07-01T16:45:55.246Z",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2025-07-01T16:45:55.246Z",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2025-07-01T16:45:55.246Z",
            • "disconnectedAt": "2025-07-01T16:45:55.246Z",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "failedAt": "2025-07-01T16:45:55.246Z",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "abc123",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "deletedAt": "2025-07-01T16:45:55.246Z",
              • "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"
              },
            • "hasIdp": true,
            • "secondaryEmail": "[email protected]",
            • "firstName": "John",
            • "lastName": "Doe",
            • "startedAt": "2025-07-01T16:45:55.246Z",
            • "separatedAt": "2025-07-01T16:45:55.246Z",
            • "isContractor": true,
            • "jobTitle": "Engineer",
            • "managerId": "x00jk12-2312",
            • "managerName": "string"
            }
          ],
        • "documents": [
          • {
            • "data": [
              • {
                • "id": null,
                • "name": null,
                • "type": null,
                • "fileUrl": null,
                • "renewalDate": null,
                • "createdAt": null,
                • "updatedAt": null
                }
              ],
            • "page": 1,
            • "limit": 10,
            • "total": 100
            }
          ]
        },
      • "serviceAccountDesignator": {
        • "id": 1,
        • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z",
        • "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": "2025-07-01T16:45:55.246Z",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2025-07-01T16:45:55.246Z",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2025-07-01T16:45:55.246Z",
            • "disconnectedAt": "2025-07-01T16:45:55.246Z",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "failedAt": "2025-07-01T16:45:55.246Z",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "abc123",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
              • "deletedAt": "2025-07-01T16:45:55.246Z",
              • "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"
              },
            • "hasIdp": true,
            • "secondaryEmail": "[email protected]",
            • "firstName": "John",
            • "lastName": "Doe",
            • "startedAt": "2025-07-01T16:45:55.246Z",
            • "separatedAt": "2025-07-01T16:45:55.246Z",
            • "isContractor": true,
            • "jobTitle": "Engineer",
            • "managerId": "x00jk12-2312",
            • "managerName": "string"
            }
          ],
        • "documents": [
          • {
            • "data": [
              • {
                • "id": null,
                • "name": null,
                • "type": null,
                • "fileUrl": null,
                • "renewalDate": null,
                • "createdAt": null,
                • "updatedAt": null
                }
              ],
            • "page": 1,
            • "limit": 10,
            • "total": 100
            }
          ]
        },
      • "hasMfa": true,
      • "connection": {
        • "id": "1",
        • "clientType": "GOOGLE",
        • "state": "ACTIVE",
        • "connected": false,
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "failedAt": "2025-07-01T16:45:55.246Z",
        • "companyId": "12341234",
        • "assignmentId": "FLk12AsS",
        • "user": {
          • "id": 1,
          • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
          • "email": "[email protected]",
          • "firstName": "Sally",
          • "lastName": "Smith",
          • "jobTitle": "CEO",
          • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
          • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z",
          • "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": "2025-07-01T16:45:55.246Z",
              • "invitationEmail": "[email protected]",
              • "linkedAt": "2025-07-01T16:45:55.246Z",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "identities": [
            • {
              • "id": 1,
              • "identityId": "1a2b3c",
              • "username": "Username",
              • "connectedAt": "2025-07-01T16:45:55.246Z",
              • "disconnectedAt": "2025-07-01T16:45:55.246Z",
              • "hasMfa": true,
              • "user": { },
              • "connection": { },
              • "hasIdp": true,
              • "secondaryEmail": "[email protected]",
              • "firstName": "John",
              • "lastName": "Doe",
              • "startedAt": "2025-07-01T16:45:55.246Z",
              • "separatedAt": "2025-07-01T16:45:55.246Z",
              • "isContractor": true,
              • "jobTitle": "Engineer",
              • "managerId": "x00jk12-2312",
              • "managerName": "string"
              }
            ],
          • "documents": [
            • {
              • "data": [
                • null
                ],
              • "page": 1,
              • "limit": 10,
              • "total": 100
              }
            ]
          },
        • "accountId": "string",
        • "clientId": "abc123",
        • "clientAlias": "My-connection-alias-1",
        • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
        • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
        • "deletedAt": "2025-07-01T16:45:55.246Z",
        • "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"
        },
      • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "writeAccess": "2025-07-01T16:45:55.246Z",
      • "pushProductionCodeAccess": "2025-07-01T16:45:55.246Z"
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}
Update version control user identity connection status
Update the connection status for the target version control user identity


🔒 Requires Connections: Manage Version Control User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
userId
required
number or null
The desired user id to link or null to unlink


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/version-control/{id}/connect
Request samples 
application/json
{
  • "userId": 1
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "writeAccess": "2025-07-01T16:45:55.246Z",
  • "pushProductionCodeAccess": "2025-07-01T16:45:55.246Z"
}
Update target version control user identity toggle settings
Update the toggle setting for the target version control user identity


🔒 Requires Connections: Manage Version Control User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
toggle
required
boolean
Toggle value for the setting


 
toggleField
string
The target toggle to update


 Enum: "VERSION_CONTROL_WRITE_ACCESS" "VERSION_CONTROL_PUSH_PROD_CODE_ACCESS"  
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/version-control/{id}/toggle
Request samples 
application/json
{
  • "toggle": true,
  • "toggleField": "VERSION_CONTROL_WRITE_ACCESS"
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "writeAccess": "2025-07-01T16:45:55.246Z",
  • "pushProductionCodeAccess": "2025-07-01T16:45:55.246Z"
}
Update version control user identity to a service account
Update the target version control user identity to a service account


🔒 Requires Connections: Manage Version Control User Identities permission.


Securitybearer 
Request 
path Parameters
id
required
number
 
Request Body schema: application/json
required
serviceAccount
required
boolean
Determines service account state


 
serviceAccountReason
required
string  <= 30000 characters 
Reason why this account is being marked as a service account


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


402
You must upgrade your plan to use this feature


403
You are not allowed to perform this action


404
Not Found


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


500
Internal server error


put/user-identities/version-control/{id}/service-account
Request samples 
application/json
{
  • "serviceAccount": true,
  • "serviceAccountReason": "This account is used to deploy"
}
Response samples 
application/json
{
  • "id": 1,
  • "identityId": "1a2b3c",
  • "username": "Username",
  • "email": "[email protected]",
  • "connectedAt": "2025-07-01T16:45:55.246Z",
  • "disconnectedAt": "2025-07-01T16:45:55.246Z",
  • "serviceAccount": "2025-07-01T16:45:55.246Z",
  • "serviceAccountReason": "This user is used to deploy code",
  • "user": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "serviceAccountDesignator": {
    • "id": 1,
    • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
    • "createdAt": "2025-07-01T16:45:55.246Z",
    • "updatedAt": "2025-07-01T16:45:55.246Z",
    • "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": "2025-07-01T16:45:55.246Z",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2025-07-01T16:45:55.246Z",
        • "createdAt": "2025-07-01T16:45:55.246Z",
        • "updatedAt": "2025-07-01T16:45:55.246Z"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2025-07-01T16:45:55.246Z",
        • "disconnectedAt": "2025-07-01T16:45:55.246Z",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "failedAt": "2025-07-01T16:45:55.246Z",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "abc123",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
          • "deletedAt": "2025-07-01T16:45:55.246Z",
          • "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"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "2025-07-01T16:45:55.246Z",
        • "separatedAt": "2025-07-01T16:45:55.246Z",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": "string"
        }
      ],
    • "documents": [
      • {
        • "data": [
          • {
            • "id": 1,
            • "name": "Security Training",
            • "type": "SEC_TRAINING",
            • "fileUrl": "http://localhost:5000/download/documents/1",
            • "renewalDate": "2026-10-27",
            • "createdAt": "2025-07-01T16:45:55.246Z",
            • "updatedAt": "2025-07-01T16:45:55.246Z"
            }
          ],
        • "page": 1,
        • "limit": 10,
        • "total": 100
        }
      ]
    },
  • "hasMfa": true,
  • "connection": {
    • "id": "1",
    • "clientType": "GOOGLE",
    • "state": "ACTIVE",
    • "connected": false,
    • "connectedAt": "2025-07-01T16:45:55.246Z",
    • "failedAt": "2025-07-01T16:45:55.246Z",
    • "companyId": "12341234",
    • "assignmentId": "FLk12AsS",
    • "user": {
      • "id": 1,
      • "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
      • "email": "[email protected]",
      • "firstName": "Sally",
      • "lastName": "Smith",
      • "jobTitle": "CEO",
      • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
      • "drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
      • "createdAt": "2025-07-01T16:45:55.246Z",
      • "updatedAt": "2025-07-01T16:45:55.246Z",
      • "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": "2025-07-01T16:45:55.246Z",
          • "invitationEmail": "[email protected]",
          • "linkedAt": "2025-07-01T16:45:55.246Z",
          • "createdAt": "2025-07-01T16:45:55.246Z",
          • "updatedAt": "2025-07-01T16:45:55.246Z"
          }
        ],
      • "identities": [
        • {
          • "id": 1,
          • "identityId": "1a2b3c",
          • "username": "Username",
          • "connectedAt": "2025-07-01T16:45:55.246Z",
          • "disconnectedAt": "2025-07-01T16:45:55.246Z",
          • "hasMfa": true,
          • "user": { },
          • "connection": { },
          • "hasIdp": true,
          • "secondaryEmail": "[email protected]",
          • "firstName": "John",
          • "lastName": "Doe",
          • "startedAt": "2025-07-01T16:45:55.246Z",
          • "separatedAt": "2025-07-01T16:45:55.246Z",
          • "isContractor": true,
          • "jobTitle": "Engineer",
          • "managerId": "x00jk12-2312",
          • "managerName": "string"
          }
        ],
      • "documents": [
        • {
          • "data": [
            • {
              • "id": 1,
              • "name": "Security Training",
              • "type": "SEC_TRAINING",
              • "fileUrl": "http://localhost:5000/download/documents/1",
              • "renewalDate": "2026-10-27",
              • "createdAt": "2025-07-01T16:45:55.246Z",
              • "updatedAt": "2025-07-01T16:45:55.246Z"
              }
            ],
          • "page": 1,
          • "limit": 10,
          • "total": 100
          }
        ]
      },
    • "accountId": "string",
    • "clientId": "abc123",
    • "clientAlias": "My-connection-alias-1",
    • "manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
    • "deletedAt": "2025-07-01T16:45:55.246Z",
    • "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"
    },
  • "lastCheckedAt": "2025-07-01T16:45:55.246Z",
  • "createdAt": "2025-07-01T16:45:55.246Z",
  • "updatedAt": "2025-07-01T16:45:55.246Z",
  • "writeAccess": "2025-07-01T16:45:55.246Z",
  • "pushProductionCodeAccess": "2025-07-01T16:45:55.246Z"
}