Find version control user identities

List user version control identities for the target client type.

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

403

You are not allowed to perform this action

500

Internal server error

default

Response Code: 412

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

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