List users given the provided search terms and filters
🔒 Requires Personnel & Users: List Users permission.
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "data": [
- {
- "id": 1,
- "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
- "firstName": "Sally",
- "lastName": "Smith",
- "jobTitle": "CEO",
- "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",
- "manualCheckDate": "2020-07-06",
- "manuallyCheckUrl": "url.com",
- "type": "CERTN",
- "source": "DRATA",
- "reportData": "string",
- "user": { },
- "outOfScopeReason": "abc123",
- "outOfScopeAt": "2025-07-01T16:45:55.246Z",
- "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": [
- {
- "id": 1,
- "name": "Drata",
- "description": "Platform to track SOC 2 compliance within the organization",
- "howItWorks": null,
- "primary": true
}
], - "providerTypes": [
- 5
], - "code": 10010,
- "groupIdList": [
- "00g1a2b3c4d5e6f7g8h9",
- "00g9h8g7f6e5d4c3b2a1"
]
}, - "hasIdp": true,
- "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",
- "renewalDate": "2026-10-27",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
], - "page": 1,
- "limit": 10,
- "total": 100
}
]
}
], - "page": 1,
- "limit": 10,
- "total": 100
}Get the full detail of a user record
🔒 Requires Personnel & Users: Get User permission.
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "id": 1,
- "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
- "firstName": "Sally",
- "lastName": "Smith",
- "jobTitle": "CEO",
- "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",
- "manualCheckDate": "2020-07-06",
- "manuallyCheckUrl": "url.com",
- "type": "CERTN",
- "source": "DRATA",
- "reportData": "string",
- "user": { },
- "outOfScopeReason": "abc123",
- "outOfScopeAt": "2025-07-01T16:45:55.246Z",
- "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": [
- {
- "id": 1,
- "name": "Drata",
- "description": "Platform to track SOC 2 compliance within the organization",
- "howItWorks": null,
- "primary": true
}
], - "providerTypes": [
- 5
], - "code": 10010,
- "groupIdList": [
- "00g1a2b3c4d5e6f7g8h9",
- "00g9h8g7f6e5d4c3b2a1"
]
}, - "hasIdp": true,
- "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",
- "renewalDate": "2026-10-27",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
], - "page": 1,
- "limit": 10,
- "total": 100
}
]
}Get the full detail of a user record
🔒 Requires Personnel & Users: Get User permission.
Invalid Authorization
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "id": 1,
- "entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
- "firstName": "Sally",
- "lastName": "Smith",
- "jobTitle": "CEO",
- "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",
- "manualCheckDate": "2020-07-06",
- "manuallyCheckUrl": "url.com",
- "type": "CERTN",
- "source": "DRATA",
- "reportData": "string",
- "user": { },
- "outOfScopeReason": "abc123",
- "outOfScopeAt": "2025-07-01T16:45:55.246Z",
- "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": [
- {
- "id": 1,
- "name": "Drata",
- "description": "Platform to track SOC 2 compliance within the organization",
- "howItWorks": null,
- "primary": true
}
], - "providerTypes": [
- 5
], - "code": 10010,
- "groupIdList": [
- "00g1a2b3c4d5e6f7g8h9",
- "00g9h8g7f6e5d4c3b2a1"
]
}, - "hasIdp": true,
- "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",
- "renewalDate": "2026-10-27",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
], - "page": 1,
- "limit": 10,
- "total": 100
}
]
}List user documents given the provided search terms and filters.
🔒 Requires Personnel & Users: List User Documents permission.
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "documents": [
- {
- "id": 1,
- "name": "Security Training",
- "type": "SEC_TRAINING",
- "renewalDate": "2026-10-27",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
]
}Upload document for user.
🔒 Requires Personnel & Users: Create User Document permission.
Created
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
The file was too large to upload
Internal server error
Third party system was unavailable
{- "id": 1,
- "name": "Security Training",
- "type": "SEC_TRAINING",
- "renewalDate": "2026-10-27",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}Get signed download link for user document.
🔒 Requires Personnel & Users: Download User Document permission.
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{- "fileBuffer": {
- "buffer": "RXhhbXBsZSB0ZXh0IGNvbnRlbnQ="
}, - "fileName": "Artifact 3.png"
}Remove user document.
🔒 Requires Personnel & Users: Delete User Document permission.
Successful
Malformed data and/or validation errors
Invalid Authorization
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{ }