The Drata connector lets your AI agent act in each user's Drata account. Each user connects their own Drata access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 26 · 4 · 026 read4 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Drata connection
In AgentKit > Connections, create a Drata connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'drata'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Drata:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'drata_company_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "drata"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Drata:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="drata_company_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Drata credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooldrata_company_getGet the Drata account's company profile.Read-onlyGet Company
Get the Drata account's company profile. Returns the company name, legal name, domain, description, training and background-check settings, and entitlements. Use this to confirm which Drata account the connection uses.
Inputs
This tool takes no inputs.
drata_control_getGet one control in a Drata workspace by ID.Read-onlyGet Control
Get one control in a Drata workspace by ID. Returns the control's code, name, description, question, activity, rationale, framework tags, owners, linked requirement, test and evidence IDs, and timestamps. Use this when you have a control ID. Use drata_controls_list to find one.
Inputs
controlIdstringrequired- The ID of the control. Get it from drata_controls_list. Example: 101.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, evidenceIds, flags, frameworkTags, owners, requirements, testIds, topics. Example: ["customFields"].
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_control_owners_listList the users who own a Drata control.Read-onlyList Control Owners
List the users who own a Drata control. Returns each owner's user id, name and email. Use this to find who is responsible for a control.
Inputs
controlIdintegerrequired- The ID of the control. Get it from drata_controls_list. Example: 101.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
excludeUserIdsarray- User IDs of the Control Owners to exclude. Example: [].
frameworkSlugstring- Filter data by Users associated with this Control Requirement Framework slug. Example: soc2.
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
includeUserIdsarray- User IDs of the Control Owners to return. Example: [1, 2, 3].
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_control_requirements_listList the framework requirements mapped to a Drata control.Read-onlyList Control Requirements
List the framework requirements mapped to a Drata control. Returns each requirement's id, name, description and framework, with pagination. Use this to see which framework requirements a control satisfies.
Inputs
controlIdintegerrequired- The ID of the control. Get it from drata_controls_list. Example: 101.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
excludeIdsarray- Exclude requirements by array of IDs. Example: [].
frameworkSlugstring- Filter data by controls associated with these framework slugs. This parameter is intended to be used only for custom frameworks. Example: slug.
frameworkTagarray- Filter data by controls associated with these framework tags. Valid values include NONE, SOC_2, ISO27001, CCPA, GDPR, HIPAA, PCI, SCF, NIST80053, NISTCSF, CMMC, NIST800171 and more. Example: ["SOC_2", "ISO27001"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_controls_listList the controls in a Drata workspace, filtered by readiness, monitoring, evidence, policy, test results or approval status.Read-onlyList Controls
List the controls in a Drata workspace, filtered by readiness, monitoring, evidence, policy, test results or approval status. Returns each control's id, code, name, description, framework tags, owners and linked test and evidence IDs, with a cursor for the next page. Use this to review control status. Use drata_control_get for one control.
Inputs
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, evidenceIds, flags, frameworkTags, owners, requirements, testIds, topics. Example: ["customFields"].
hasEvidenceboolean- Filter to Controls with or without Evidence. Example: true.
hasPassingTestboolean- Filter to Controls with at least one passing Test. Example: true.
hasPolicyboolean- Filter to Controls with or without Policy. Example: true.
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
isArchivedboolean- Filter Controls that are or are not archived. Example: false.
isEnabledboolean- Filter Controls that are or are not enabled. Example: true.
isMonitoredboolean- Filter Controls that have or do not have a Monitor. Example: false.
isReadyboolean- Filter Controls that are or are not ready. Example: false.
policyIdinteger- The ID of the policy. Get it from drata_policies_list. Example: 301.
requiredApprovalsstring- Filter Controls by the status of their required approval. CHANGES_REQUESTED, NEEDS_APPROVAL and PREPARE_FOR_APPROVERS identify Controls that are not ready because their approval is still in progress; APPROVED and NO_REVIEW do not block readiness. Approval status only applies to enabled Controls, so this filter cannot be combined with isEnabled=false. Example: PREPARE_FOR_APPROVERS.one of
PREPARE_FOR_APPROVERSNEEDS_APPROVALAPPROVEDCHANGES_REQUESTEDNO_REVIEW sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC ticketStatusstring- Only include Controls with an associated Task Management Ticket. Example: IN_PROGRESS.one of
IN_PROGRESSARCHIVED
drata_events_listList Drata events (the audit trail of changes, test runs and syncs), filtered by type, source, category, connection, user, workspace or date.Read-onlyList Events
List Drata events (the audit trail of changes, test runs and syncs), filtered by type, source, category, connection, user, workspace or date. Returns each event's id, type, category, source, description, user and time, with a cursor for the next page. Use this to see what changed recently in Drata.
Inputs
categorystring- Filter data to events of this category. Valid values include AUTOPILOT, AGENT, POLICY, PERSONNEL, REPORT, VENDOR, ASSET, COMPANY, ASSESSMENT, AUDIT, MONITOR, USER and more. Example: AUTOPILOT.
connectionIdinteger- The connection to filter events by. A null/blank value will return events without a connection. Example: 123.
createdAtEndDatestring- Filters the events to those with a creation date less than or equal to this date and time. Example: 2026-01-15.
createdAtStartDatestring- Filters the events to those with a creation date greater than or equal to this date and time. Example: 2026-01-15.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: connection, issues, metadata, testId, testName, user. Example: ["connection"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Events can only be sorted by create date. Example: createdAt.one of
createdAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC sourcestring- Filter data to events of this source. Example: APP.one of
APPAUTOPILOTPUBLIC_APIVENDOR_QUESTIONNAIRESCHEDULEDWORKFLOWDRATA_POLICYAUDIT_AGENTDRATA_MIGRATION typestring- Filter data to events of this type. Valid values include COMPANY_DATA_UPDATED, COMPANY_LOGO_UPDATED, COMPANY_KEY_PERSONNEL_UPDATED, COMPANY_ROLES_UPDATED, COMPANY_SECURITY_DATA_UPDATED, COMPANY_DOCUMENT_UPLOADED, COMPANY_DOCUMENT_DOWNLOADED, COMPANY_DOCUMENT_DELETED, COMPANY_HUMAN_RESOURCES_DATA_UPDATED, EMPLOYMENT_STATUS_UPDATED, REMINDER_EMAIL_SENT, POLICIES_DOWNLOAD_ALL and more. Example: COMPANY_DATA_UPDATED.
userIdinteger- The Drata user ID. Get it from drata_users_list. Example: 456.
workspaceIdinteger- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
drata_evidence_artifacts_listList the artifacts (files, URLs or text) attached to a Drata evidence item.Read-onlyList Evidence Artifacts
List the artifacts (files, URLs or text) attached to a Drata evidence item. Returns each artifact's id, name, extension, version, source, type and dates, with pagination. Use this to see what has been uploaded as proof for an evidence item.
Inputs
evidenceIdintegerrequired- The ID of the evidence item. Get it from drata_evidence_list. Example: 789.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
artifactTypesarray- Filter artifacts by type. Valid values: URL, S3_FILE, TICKET_PROVIDER, NONE, GOOGLE_DRIVE, ONE_DRIVE, BOX, DROPBOX, SHARE_POINT, TEST_RESULT. Example: ["URL"].
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
isArchivedboolean- True returns only archived (past) artifacts, false only active ones. Omit to return both. Example: false.
namestring- Filter artifacts by name (prefix match). Example: Q4-2024-Security-Audit.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_evidence_getGet one evidence item in a Drata workspace by ID.Read-onlyGet Evidence
Get one evidence item in a Drata workspace by ID. Returns the evidence item's name, description, implementation guidance, status, renewal date and schedule, owners, artifacts and linked controls. Use this when you have an evidence ID. Use drata_evidence_artifacts_list for its files and links.
Inputs
evidenceIdintegerrequired- The ID of the evidence item. Get it from drata_evidence_list. Example: 789.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
expandarray- List of subcollections and sub-objects to expand. Valid values: owners, artifacts, controls. Example: ["owners"].
drata_evidence_listList the evidence items in a Drata workspace, filtered by name, owner, framework, status or artifact type.Read-onlyList Evidence
List the evidence items in a Drata workspace, filtered by name, owner, framework, status or artifact type. Returns each evidence item's id, name, description, status, renewal date and schedule, owners, artifacts and linked controls, with a cursor for the next page. Use this to check evidence status. Use drata_evidence_get for one item.
Inputs
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
artifactTypesarray- Filter evidence items by artifact types. Valid values: URL, S3_FILE, TICKET_PROVIDER, NONE, GOOGLE_DRIVE, ONE_DRIVE, BOX, DROPBOX, SHARE_POINT, TEST_RESULT. Example: ["URL"].
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
evidenceStatusesarray- Filter evidence items by statuses. Valid values: NEEDS_ARTIFACT, EXPIRED, EXPIRING_SOON, TEST_ERROR, TEST_FAILED, READY, TEST_PASSED, TEST_UNUSED, TEST_DISABLED, TEST_DELETED. Example: ["NEEDS_ARTIFACT"].
expandarray- List of subcollections and sub-objects to expand. Valid values: owners, artifacts, controls. Example: ["owners"].
frameworkIdsarray- Array of Ids of frameworks to be used as filters. Example: [1, 2, 3].
namestring- Filter evidence items by name (prefix match). Example: SOC2 Evidence.
ownerIdsarray- IDs of the users that own the evidence current version. Example: [1, 2, 3].
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_framework_requirements_listList the requirements of one framework in a Drata workspace.Read-onlyList Framework Requirements
List the requirements of one framework in a Drata workspace. Returns each requirement's id, code, name, description, category, framework and mapped controls, with pagination. Use this to review a framework's requirements. Use drata_control_requirements_list to go from a control to its requirements.
Inputs
frameworkIdintegerrequired- The ID of the framework. Get it from drata_frameworks_list. Example: 3.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
excludeIdsarray- Exclude Requirements by array of IDs. Example: [].
expandarray- List of subcollections and sub-objects to expand. `controls` includes a limited subcollection of Controls mapped to each Requirement. `customFields` includes Custom Field values for each Requirement. `framework` includes a compact Framework object on each Requirement. Valid values: controls, customFields, framework. Example: ["controls"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
isInScopeboolean- Filter Requirements that are or are not in scope (not archived). Example: true.
isReadyboolean- Filter Requirements that are or are not ready. Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_frameworks_listList the compliance frameworks (such as SOC 2, ISO 27001 or HIPAA) in a Drata workspace.Read-onlyList Frameworks
List the compliance frameworks (such as SOC 2, ISO 27001 or HIPAA) in a Drata workspace. Returns each framework's id, name, tag, readiness counts and whether it is enabled, with pagination. Use this to find a framework ID and see overall readiness.
Inputs
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
excludeIdsarray- Array of Framework IDs to exclude from results. Example: [1, 2, 3].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
isEnabledboolean- Filter Frameworks by enabled state. Example: true.
isReadyboolean- Filter Frameworks by ready state. Example: true.
namestring- Filter Frameworks by name (partial match). Example: SOC 2.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_monitoring_test_failures_listList the resources that fail a Drata monitoring test.Read-onlyList Monitoring Test Failures
List the resources that fail a Drata monitoring test. Returns each failing resource with its status, provider, resource name and type, account, region and cause, plus the time of the last check, with a cursor for the next page. Use this to see what needs fixing for a failing test.
Inputs
testIdintegerrequired- The ID of the monitoring test. Get it from drata_monitoring_tests_list. Example: 1.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Pass `tags` to include cloud-provider resource tags on each item when available. Tag resolution may add latency to the response. Tags are not present for every resource. Valid values: tags. Example: ["tags"].
includeExclusionsboolean- Include excluded Monitor Test failures in the results. Excluded findings are returned with `status` set to `EXCLUDED`; findings still failing the test are returned with `status` set to `OPEN`. Example: false.
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_monitoring_test_getGet one monitoring test in a Drata workspace by ID.Read-onlyGet Monitoring Test
Get one monitoring test in a Drata workspace by ID. Returns the test's name, description, check status and result, last passed time, failing-since time and linked controls. Use this to check a test after drata_monitoring_test_retest.
Inputs
testIdintegerrequired- The ID of the monitoring test. Get it from drata_monitoring_tests_list. Example: 1.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: controls, monitorInstances, disablingUser. Example: ["controls"].
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_monitoring_tests_listList the automated monitoring tests in a Drata workspace.Read-onlyList Monitoring Tests
List the automated monitoring tests in a Drata workspace. Returns each test's id, name, description, check status and result, last passed time and failing-since time, with a cursor for the next page. Use this to see which automated checks pass or fail. Use drata_monitoring_test_failures_list for the failing resources.
Inputs
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
checkResultStatusstring- Filter Monitors by result status. Example: READY.one of
READYPASSEDFAILEDERRORPREAUDIT checkStatusstring- Filter Monitors by system status. Example: UNUSED.one of
UNUSEDNEWENABLEDDISABLEDTESTING cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
draftboolean- Filter Monitors by draft state: true returns only drafts, false (the default) only published tests. Example: false.
expandarray- List of subcollections and sub-objects to expand. Valid values: controls, monitorInstances, disablingUser. Example: ["controls"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
namestring- Filter Monitors by name (prefix match, case-insensitive). Send it again with each `cursor` page. Example: MFA.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC testSourcestring- Filter monitors by test source type (DRATA for built-in tests, CUSTOM for user-created tests, ACORN for compliance-as-code tests, EXTERNAL for external tests, DRATA_LIBRARY for Drata library tests). Example: DRATA.one of
DRATACUSTOMEXTERNALACORNDRATA_LIBRARY typestring- Filter Monitors by check type (associated monitor instances). Example: POLICY.one of
POLICYIN_DRATAAGENTINFRASTRUCTUREVERSION_CONTROLIDENTITYTICKETINGHRISOBSERVABILITYCUSTOM
drata_personnel_devices_listList the devices registered to a Drata personnel record.Read-onlyList Personnel Devices
List the devices registered to a Drata personnel record. Returns each device's id, OS version, serial number, model, compliance flag and checks, and security settings such as screen lock, antivirus and encryption, with pagination. Use this to check a person's device compliance.
Inputs
personnelIdstringrequired- The personnel record ID from drata_personnel_list, or the person's email prefixed with email: (for example email:jane@example.com). Example: 123.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: asset, complianceChecks, documents, identifiers. Example: ["asset"].
externalIdstring- An externally sourced unique identifier for a device. Example: example.
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
macAddressstring- The device MAC address. Example: 65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E.
serialNumberstring- The device serial number. Example: NKRTSPY456.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC sourceTypestring- Device source type. Example: AGENT.one of
AGENTJAMFINTUNEKANDJIJUMPCLOUDHEXNODE_UEMUNKNOWNRIPPLINGWORKSPACE_ONEKOLIDECUSTOMINTUNE_GCC_HIGHCUSTOM_XFANINJAONE
drata_personnel_getGet one personnel record in Drata by ID or by email.Read-onlyGet Personnel
Get one personnel record in Drata by ID or by email. Returns the person's user, employment status, dates, compliance checks and any expanded sub-objects. Use this to check one person's compliance status. Use drata_personnel_list to browse.
Inputs
personnelIdstringrequired- The personnel record ID from drata_personnel_list, or the person's email prefixed with email: (for example email:jane@example.com). Example: 123.
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, complianceChecks, reasonProvider, user. Example: ["customFields"].
drata_personnel_listList personnel records in Drata, filtered by employment or compliance status.Read-onlyList Personnel
List personnel records in Drata, filtered by employment or compliance status. Returns each person's id, user, employment status, start and separation dates and compliance status, with a cursor for the next page. Use this to review onboarding and compliance status across the company. Use drata_personnel_get for one person.
Inputs
complianceStatusarray- Filter Personnel by overall compliance status. Valid values: MISCONFIGURED, PASS, FAIL, EXCLUDED, NOT_ASSESSED. Example: ["MISCONFIGURED"].
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
employmentStatusarray- Personnel by employment statuses. Valid values: CURRENT_EMPLOYEE, FORMER_EMPLOYEE, CURRENT_CONTRACTOR, FORMER_CONTRACTOR, OUT_OF_SCOPE, UNKNOWN, SPECIAL_FORMER_EMPLOYEE, SPECIAL_FORMER_CONTRACTOR, FUTURE_HIRE, SERVICE_ACCOUNT. Example: ["CURRENT_EMPLOYEE"].
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, complianceChecks, reasonProvider, user. Example: ["customFields"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_policies_listList the policies in Drata.Read-onlyList Policies
List the policies in Drata. Returns each policy's id, name, description, owner, status and current version, with a cursor for the next page. Use this to review policy status. Use drata_policy_get for one policy.
Inputs
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: groups, weekTimeFrameSlas, gracePeriodSlas, p3MatrixSlas, owner. Example: ["groups"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
namestring- Filter Policies by name (partial match). Example: Data Protection Policy.
reviewerStatusarray- Filter Policies by the reviewer's review status on an active approval. Typically used with reviewerUserId. Valid values: READY_FOR_REVIEW, APPROVED, CHANGES_REQUESTED, DEADLINE_EXCEEDED. Example: ["READY_FOR_REVIEW"].
reviewerUserIdstring- Filter Policies by a reviewer. A Drata integer ID, an email address of the form 'email:value', or 'me' to reference the authenticated user. Note: 'me' is only available when authenticating with OAuth 2.1 Authorization Code grant, not with Public API Keys. Example: me.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC statusesarray- Filter Policies by one or more statuses. Valid values: ACTIVE, ARCHIVED, REPLACED, UNACCEPTABLE, OUTDATED. Example: ["ACTIVE"].
drata_policy_getGet one Drata policy by ID.Read-onlyGet Policy
Get one Drata policy by ID. Returns the policy's name, description, scope, owner, status, current version, renewal date and publish and approval dates. Use this when you have a policy ID. Use drata_policies_list to find one.
Inputs
policyIdintegerrequired- The ID of the policy. Get it from drata_policies_list. Example: 301.
expandarray- List of subcollections and sub-objects to expand. Valid values: groups, controls, weekTimeFrameSlas, gracePeriodSlas, p3MatrixSlas, owner. Example: ["groups"].
drata_risks_searchSearch risks across every Drata risk register by text, status, treatment plan, type, score, dates, owners or linked controls.Read-onlySearch Risks
Search risks across every Drata risk register by text, status, treatment plan, type, score, dates, owners or linked controls. Returns matching risks with their scores, treatment plan, owners and status, with a cursor for the next page. Use this to find risks. Expand owners, controls or notes to include them.
Inputs
anticipatedCompletionDateGtestring- Filter Risks with anticipated completion date on or after this ISO 8601 timestamp. Example: 2026-01-15.
anticipatedCompletionDateLtestring- Filter Risks with anticipated completion date on or before this ISO 8601 timestamp. Example: 2026-01-15.
categoriesarray- Filter Risks by exact category name membership. Example: ["example"].
completedDateGtestring- Filter Risks with actual completion date on or after this ISO 8601 timestamp. Example: 2026-01-15.
completedDateLtestring- Filter Risks with actual completion date on or before this ISO 8601 timestamp. Example: 2026-01-15.
controlsarray- Filter Risks by exact control code membership (e.g. `AC-04`). Example: ["example"].
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: owners, reviewers, controls, categories, documents, notes, tickets, tasks, customFields. Example: ["owners"].
facetsarray- Filter dimensions for which to return value counts in the response. Only honored on the first page (when `cursor` is null). Each requested facet adds one terms aggregation to the search query. Bounded enum facets (`status`, `treatmentPlan`, `type`) are enriched with zero-count entries; unbounded facets (`categories`, `controls`, `ownerEmails`, `reviewerEmails`, `vendorNames`, `riskRegisterId`) return only values present in the result set. Valid values: status, treatmentPlan, type, categories, controls, ownerEmails, reviewerEmails, vendorNames, riskRegisterId. Example: ["status"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
inherentScoreGtenumber- Filter Risks by minimum inherent (pre-mitigation) score (inclusive). Example: 10.
inherentScoreLtenumber- Filter Risks by maximum inherent (pre-mitigation) score (inclusive). Example: 10.
ownerEmailsarray- Filter Risks by owner email membership. Example: ["example"].
qstring- Free-text search across `title`, `description`, `riskId`, and `vendorName`. Fuzzy, prefix-aware, and relevance-ranked. Example: unauthorized access.
residualScoreGtenumber- Filter Risks by minimum residual (post-mitigation) score (inclusive). Example: 10.
residualScoreLtenumber- Filter Risks by maximum residual (post-mitigation) score (inclusive). Example: 10.
reviewerEmailsarray- Filter Risks by reviewer email membership. Example: ["example"].
riskRegisterIdarray- Narrow results to Risks in this subset of Risk Registers. Each ID must be a Risk Register the caller can access; unknown or inaccessible IDs are silently filtered out. Omit to search every Risk Register accessible to the caller. Example: [1, 2].
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Highest residual risk first (with `sortDir=DESC`, the default) is the natural default view for a risk register. Example: residualScore.one of
residualScoreinherentScoreanticipatedCompletionDatecompletedDatetitleriskIdstatusvendorNamecreatedAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC statusarray- Filter Risks by one or more workflow statuses. Valid values: ACTIVE, ARCHIVED, CLOSED. Example: ["ACTIVE"].
treatmentPlanarray- Filter Risks by treatment plan. Valid values: UNTREATED, ACCEPT, TRANSFER, AVOID, MITIGATE. Example: ["UNTREATED"].
typearray- Filter Risks by version type. Valid values: INTERNAL, EXTERNAL. Example: ["INTERNAL"].
vendorNamesarray- Filter Risks by exact vendor name membership. Each Risk is indexed with a single vendor name (the first associated vendor), so a Risk matches if that vendor name is in the supplied list. Example: ["example"].
drata_tasks_listList the custom tasks in a Drata workspace.Read-onlyList Tasks
List the custom tasks in a Drata workspace. Returns each task's id, title, description, type, assignee, due date and completion status, with pagination. Use this to review open compliance tasks. Use drata_task_create to add one.
Inputs
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
assigneeIdinteger- Filter by assigned User ID. Example: 456.
controlIdinteger- The ID of the control. Get it from drata_controls_list. Example: 101.
createdByIdinteger- Filter by User ID who created the task. Example: 123.
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
descriptionstring- Filter by Task description (prefix search). Example: quarterly review.
dueDateFromstring- Filter Tasks with due date on or after this value (inclusive). Example: 2020-07-06.
dueDateTostring- Filter Tasks with due date on or before this value (inclusive). Example: 2020-07-06.
expandarray- List of subcollections and sub-objects to expand. Valid values: assignee, createdBy, controls, risks, policies, schedule. Example: ["assignee"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAtdueDate sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC statusstring- Filter by Task status. Example: PAST_DUE.one of
PAST_DUECOMPLETEDINCOMPLETE taskTypestring- Filter by Task type. Example: POLICY_RENEWALS.one of
POLICY_RENEWALSEVIDENCEVENDOREXTERNAL_EVIDENCEREPORTGENERALCONTROLRISKCONTROL_APPROVALSPOLICY_APPROVALS titlestring- Filter by Task title (prefix search). Example: Review SOC 2.
drata_user_getGet one Drata user by ID.Read-onlyGet User
Get one Drata user by ID. Returns the user's email, name, job title and roles, plus background checks, documents or identities when expanded. Use this when you have a user ID. Use drata_users_list to find one.
Inputs
userIdstringrequired- The Drata user ID. Get it from drata_users_list. Example: 456.
expandarray- List of subcollections and sub-objects to expand. Valid values: backgroundChecks, documents, personnel, identities, roles. Example: ["backgroundChecks"].
drata_users_listList users in the Drata account, optionally filtered by first or last name.Read-onlyList Users
List users in the Drata account, optionally filtered by first or last name. Returns each user's id, email, name, job title and roles, with a cursor for the next page. Use this to find a user ID for owners and assignees. Use drata_user_get for one user.
Inputs
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: backgroundChecks, documents, personnel, identities, roles. Example: ["backgroundChecks"].
firstNamestring- Filter users whose first name starts with the provided value (prefix match). For example, `firstName=John` matches users named John, Johnathan, Johnny, etc. Example: John.
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
lastNamestring- Filter users whose last name starts with the provided value (prefix match). For example, `lastName=Sm` matches users named Smith, Smithson, etc. Example: Doe.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_vendor_getGet one vendor in Drata by ID.Read-onlyGet Vendor
Get one vendor in Drata by ID. Needs a Drata TPRM plan. Returns the vendor's category, risk, type, status, URLs, services provided, data stored, PII flag, password policy and contacts. Use this when you have a vendor ID. Use drata_vendors_list to find one.
Inputs
vendorIdintegerrequired- The ID of the vendor. Get it from drata_vendors_list. Example: 55.
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, documents, integrations, lastQuestionnaire, latestSecurityReviews, reviews, vendorUser, vendorRelationshipContact, dataAccessedOrProcessed, scheduleConfiguration, customVendorType, inherentRiskLevel, residualRiskLevel. Example: ["customFields"].
drata_vendors_listList the third-party vendors tracked in Drata, filtered by category, risk, status, type or renewal.Read-onlyList Vendors
List the third-party vendors tracked in Drata, filtered by category, risk, status, type or renewal. Needs a Drata TPRM plan. Returns each vendor's id, name, category, risk, type, status and critical flag, with a cursor for the next page. Use this to review vendor risk. Use drata_vendor_get for one vendor.
Inputs
actionRequiredboolean- Filter to "action required" vendors: current (not prospective/archived), with a directory entry and an owner email, whose renewal is due soon or overdue. Example: true.
categoriesarray- Filter to Vendors in any of these categories (business unit). Multi-select is OR. Valid values: ENGINEERING, PRODUCT, MARKETING, CS, SALES, FINANCE, HR, ADMINISTRATIVE, SECURITY, LEGAL, INFORMATION_TECHNOLOGY, NONE. Example: ["ENGINEERING"].
categorystring- The category of the Vendors. Example: ENGINEERING.one of
ENGINEERINGPRODUCTMARKETINGCSSALESFINANCEHRADMINISTRATIVESECURITYLEGALINFORMATION_TECHNOLOGYNONE cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: customFields, documents, integrations, lastQuestionnaire, latestSecurityReviews, reviews, vendorUser, vendorRelationshipContact, dataAccessedOrProcessed, scheduleConfiguration, customVendorType, inherentRiskLevel, residualRiskLevel. Example: ["customFields"].
impactLevelstring- Overall Vendor impact level. Example: INSIGNIFICANT.one of
INSIGNIFICANTMINORMODERATEMAJORCRITICALUNSCORED includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
isSubProcessorboolean- Filter to sub-processor vendors (true) or non-sub-processors (false). Example: true.
nextReviewDeadlineStatusarray- Filter by next-review-deadline status: NO_RENEWAL / DUE_SOON / OVERDUE (multi-select is OR). Valid values: NO_RENEWAL, DUE_SOON, OVERDUE. Example: ["NO_RENEWAL"].
renewalDatestring- Vendor renewal date (date-only YYYY-MM-DD, matched exactly). Example: 2020-07-06.
renewalScheduleTypestring- Vendor renewal schedule type. Example: ONE_MONTH.one of
ONE_MONTHTWO_MONTHSTHREE_MONTHSSIX_MONTHSONE_YEARCUSTOMNONE riskstring- Filter data to Vendors of this risk level. Example: NONE.one of
NONELOWMODERATEHIGH sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC statusstring- The status of the Vendors. Example: PROSPECTIVE.one of
PROSPECTIVEACTIVEARCHIVEDAPPROVEDREJECTEDFLAGGEDON_HOLDOFFBOARDEDUNDER_REVIEWNONE statusesarray- Filter to Vendors in any of these statuses (multi-select is OR). `NONE` matches Vendors with no status set. `CURRENT` matches the current Vendor book: every Vendor that is not PROSPECTIVE or ARCHIVED, including those with no status. Valid values: PROSPECTIVE, ACTIVE, ARCHIVED, APPROVED, REJECTED, FLAGGED, ON_HOLD, OFFBOARDED, UNDER_REVIEW, NONE, CURRENT. Example: ["PROSPECTIVE"].
typestring- Vendor type. Example: VENDOR.one of
VENDORSUPPLIERCONTRACTORPARTNEROTHERNONE typesarray- Filter to Vendors of any of these types (multi-select is OR). Valid values: VENDOR, SUPPLIER, CONTRACTOR, PARTNER, OTHER, NONE. Example: ["VENDOR"].
vendorTypeIdsarray- Filter to Vendors of any of these vendor-type ids (the tenant-defined vendor-type taxonomy from vendor settings; resolve names via GET /vendor-types). Multi-select is OR. Example: [1, 2].
vendorUserIdsarray- Filter to Vendors whose security owner is one of these user IDs. Mirrors the security-owner filter in the app. Example: [1, 2, 3].
drata_workspaces_listList the workspaces in the Drata account.Read-onlyList Workspaces
List the workspaces in the Drata account. Returns each workspace's id, name, description and primary flag, with pagination. Use this first: most control, evidence, test, framework and task tools need a workspace ID.
Inputs
cursorstring- This parameter is used to paginate through results. No value is needed for the first request. If there are additional results, the response will contain a `pagination.cursor` value that can be used in the subsequent request to retrieve the next page of results. Example: eyJpZCI6MTAwfQ==.
expandarray- List of subcollections and sub-objects to expand. Valid values: frameworks, personnelScope. Example: ["frameworks"].
includeTotalCountboolean- Include total count of all matching records in response. Only honored on first page (when cursor is null). Example: false.
sizeinteger- Number of results to return. Example: 50.
sortstring- Which field to sort by. Example: createdAt.one of
createdAtupdatedAt sortDirstring- The direction to sort the data. Example: ASC.one of
ASCDESC
drata_monitoring_test_retestRun a Drata monitoring test now instead of waiting for its schedule.WriteRun Monitoring Test
Run a Drata monitoring test now instead of waiting for its schedule. The run is asynchronous: success means the run was accepted, not that the test passed. Returns the test ID and its check status. Use this after fixing a failure, then poll drata_monitoring_test_get for the result.
Inputs
testIdintegerrequired- The ID of the monitoring test. Get it from drata_monitoring_tests_list. Example: 1.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
drata_personnel_updateUpdate a Drata personnel record's start or separation date, employment status or custom fields.WriteUpdate Personnel
Update a Drata personnel record's start or separation date, employment status or custom fields. Fields you set manually stop syncing from your identity provider or HRIS. Returns the updated personnel record. Use this to correct HR data in Drata. Use drata_personnel_get to read the record first.
- Idempotent
Inputs
personnelIdstringrequired- The personnel record ID from drata_personnel_list, or the person's email prefixed with email: (for example email:jane@example.com). Example: 123.
customFieldsarray- Custom Fields for the Person. Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading. Example: [{"id": 1, "name": "Compliance Status", "value": "Security & IT"}].
employmentStatusstring- The desired employment status to be updated. Example: CURRENT_CONTRACTOR.one of
CURRENT_EMPLOYEEFORMER_EMPLOYEECURRENT_CONTRACTORFORMER_CONTRACTOROUT_OF_SCOPEUNKNOWNSPECIAL_FORMER_EMPLOYEESPECIAL_FORMER_CONTRACTORFUTURE_HIRESERVICE_ACCOUNT notHumanReasonstring- Explains why the employment status of this personnel is marked as `OUT_OF_SCOPE`. This field is required if the `employmentStatus` is set to `OUT_OF_SCOPE`. Example: This is not a real personnel, but a placeholder for anyone in charge of X.
separatedAtstring- The date when this person was separated from the company system. Example: 2020-07-06.
startedAtstring- The date when this person started working at the company. Note: Once manually set, automatic updates from identity providers (IDP) and HRIS systems will be ignored. Use the resync endpoint to restore automatic updates. Example: 2020-07-06.
drata_task_createCreate a custom task in a Drata workspace, optionally linked to controls, risks or policies.WriteCreate Task
Create a custom task in a Drata workspace, optionally linked to controls, risks or policies. Returns the created task. Use this to assign compliance follow-up work. Provide a title unless you pass configurationId for a recurring task's occurrence.
Inputs
dueDatestringrequired- Due date. With `configurationId` this selects the occurrence to create and must be a date that recurring Task actually falls on. Example: 2020-07-06.
workspaceIdintegerrequired- The ID of the Drata workspace. Get it from drata_workspaces_list. Example: 1.
assigneeIdinteger- ID of the User to assign the task to. Example: 456.
configurationIdinteger- Create this Task from an occurrence of a recurring Task, as returned by `configurationId` on Upcoming Tasks. `dueDate` then selects which occurrence, and every other property is taken from the recurring Task, so none may be sent. This is a short-lived handle rather than a durable identifier: it is replaced whenever the recurring Task is edited, so list Upcoming Tasks and create from the value in that response rather than caching it. Example: 42.
controlIdsarray- IDs of Controls to link to this Task. Can be combined with `riskIds` and `policyIds`. Example: [101, 102].
descriptionstring- Task description. Example: Quarterly review of access control policies.
policyIdsarray- IDs of Policies to link to this Task. Can be combined with `controlIds` and `riskIds`. Example: [301, 302].
riskIdsarray- IDs of Risks to link to this Task. Can be combined with `controlIds` and `policyIds`. Example: [201].
taskTypestring- Task type. Example: GENERAL.one of
POLICY_RENEWALSEVIDENCEVENDOREXTERNAL_EVIDENCEREPORTGENERALCONTROLRISKCONTROL_APPROVALSPOLICY_APPROVALS titlestring- Task title. Required unless `configurationId` is supplied. Example: Review access controls.
drata_vendor_createAdd a third-party vendor to Drata.WriteCreate Vendor
Add a third-party vendor to Drata. Needs a Drata TPRM plan. Returns the created vendor. Use this to start tracking a new vendor. Use drata_vendors_list to check it is not already there.
Inputs
namestringrequired- The name of the Vendor. Example: Acme.
accountIdstring- Account Id. Example: 36.
categorystring- The type of Vendor. Example: ENGINEERING.one of
ENGINEERINGPRODUCTMARKETINGCSSALESFINANCEHRADMINISTRATIVESECURITYLEGALINFORMATION_TECHNOLOGYNONE confirmedboolean- Indicate if all Vendor data is confirmed. Example: true.
contactAtVendorstring- Name of the corresponding account manager for this Vendor. Example: John Doe.
contactEmailstring- Semicolon-separated list of vendor contact email addresses. Example: jdoe@company.com;jane@company.com.
coststring- Annual Contract Value for the Vendor in Cents unit. Example: 1088.
criticalboolean- Indicates if the Vendor is considered critical. Example: false.
customFieldsarray- Custom Fields for the Vendor. Requires your account have the Custom Fields and Formulas feature. Contact your Account Manager for help upgrading. Example: [{"id": 1, "name": "Compliance Status", "value": "Security & IT"}].
dataAccessedOrProcessedListarray- List of data accessed or processed enum type. Valid values: GENERAL, PUBLIC, CONTROLLED_UNCLASSIFIED, FINANCIAL, PROPRIETARY, EMPLOYEE_PERSONNEL, PERSONAL_IDENTIFIABLE_INFORMATION, PROTECTED_HEALTH_INFORMATION, OTHER_PERSONAL_OR_SENSITIVE, CARDHOLDER_DATA. Example: ["FINANCIAL", "GENERAL"].
dataStoredstring- Description of the type of data the Vendor stores. Example: resulting reports of security scans.
environmentAccessstring- Vendor environment access privileges. Example: READ_ONLY.one of
NOREAD_ONLYREAD_WRITE hasPiiboolean- Indicates whether this Vendor stores any type of Personally Identifiable Information (PII). Example: true.
impactLevelstring- Vendor overall impact level. Example: INSIGNIFICANT.one of
INSIGNIFICANTMINORMODERATEMAJORCRITICALUNSCORED inherentRiskLevelIdinteger- Custom inherent risk level ID. Only honored when custom vendor risk levels are enabled. Example: 1.
integrationsarray- List of vendor IDs. Example: [1, 2, 3].
isSubProcessorboolean- Indicates whether this Vendor is considered a subprocessor. Example: false.
isSubProcessorActiveboolean- [Deprecated] Indicates whether this subprocessor is active. Example: false.
locationstring- Location where the Vendor services are provided. Example: San Diego.
notesstring- Additional notes for Vendor. Example: Meeting once a month to adjust contract.
operationalImpactstring- Vendor level of operational impact. Example: IMPORTANT.one of
NONELOWNORMALIMPORTANTCRITICAL passwordMfaEnabledboolean- Indicates whether multi-factor authentication is enabled for this Vendor. Example: true.
passwordMinLengthnumber- Minimum character length required for a password. Example: 8.
passwordPolicystring- The Vendor password policy. Example: USERNAME_PASSWORD.one of
USERNAME_PASSWORDSSOLDAPNONENOT_APPLICABLESCIMOTHER passwordRequiresMinLengthboolean- Indicates whether there is a minimum length requirement for password. Example: true.
passwordRequiresNumberboolean- Indicates whether a password requires numbers. Example: true.
passwordRequiresSymbolboolean- Indicates whether a password requires non-alpha-numeric characters. Example: true.
privacyUrlstring- Vendor Privacy Policy URL. Example: https://acme.com/privacy.
renewalDatestring- Vendor renewal date. Example: 2025-07-01T16:45:55.246Z.
renewalScheduleTypestring- Vendor renewal schedule type. Example: ONE_YEAR.one of
ONE_MONTHTWO_MONTHSTHREE_MONTHSSIX_MONTHSONE_YEARCUSTOMNONE residualRiskLevelIdinteger- Custom residual risk level ID. Only honored when custom vendor risk levels are enabled. Example: 1.
riskstring- The level of risk associated with customer data. Example: MODERATE.one of
NONELOWMODERATEHIGH servicesProvidedstring- Description of the services provided by the Vendor. Example: Perform security scans once a month.
statusstring- The status of Vendor. Example: UNDER_REVIEW.one of
PROSPECTIVEACTIVEARCHIVEDAPPROVEDREJECTEDFLAGGEDON_HOLDOFFBOARDEDUNDER_REVIEWNONE termsUrlstring- Vendor Terms of Use URL. Example: https://acme.com/terms.
trustCenterUrlstring- Vendor Trust Center URL. Example: https://trust.example.com.
typestring- Vendor type identifier. Example: VENDOR.one of
VENDORSUPPLIERCONTRACTORPARTNEROTHERNONE urlstring- Vendor URL. Example: https://acme.com.
userIdinteger- The Drata user ID. Get it from drata_users_list. Example: 456.
vendorRelationshipContactobject- The Vendor relationship contact. Pass `null` to leave it unset (no contact will be assigned). Example: {"userId": 1}.
No tools match.