Skip to main content
Server path: /hyperproof | Type: Application | PCID required: Yes Compliance management

Tools

ToolDescription
hyperproof_controlsManage compliance controls in Hyperproof. Controls represent specific security or compliance requirements that organizations must implement and monitor. Actions: list, get, create, update.
hyperproof_tasksManage tasks in Hyperproof. Tasks represent action items that need to be completed as part of compliance workflows. Actions: list, get, create, update, list_comments, create_comment, update_comment, delete_comment.
hyperproof_risksManage organizational risks in Hyperproof. Risks represent potential threats or vulnerabilities that could impact compliance or security posture. Actions: list, get, create, update.
hyperproof_issuesManage compliance issues in Hyperproof. Issues represent identified problems or deficiencies that need resolution. Actions: list, get, create, update, list_comments, create_comment, update_comment, delete_comment.
hyperproof_policiesManage organizational policies in Hyperproof. Policies define the rules and procedures that govern compliance and security practices. Actions: list, get, create, update.
hyperproof_policy_versionsManage policy versions in Hyperproof. Track different versions of policies over time as they are updated and revised. Actions: list, get, create, update.
hyperproof_programsManage compliance programs in Hyperproof. Programs represent structured compliance initiatives like SOC 2, ISO 27001, or HIPAA compliance efforts. Actions: list, get, create, update.
hyperproof_scopesManage compliance scopes in Hyperproof. Scopes define boundaries for compliance activities, such as departments, locations, or systems. Actions: list, get, create, update.
hyperproof_scope_assignmentsAssociate objects with hierarchical scopes in Hyperproof. Creates or updates scope assignments for controls, risks, or other compatible objects. Actions: create.
hyperproof_questionnairesManage compliance questionnaires in Hyperproof. Questionnaires are used to collect information from vendors or assess compliance status. Actions: list, get, create, update.
hyperproof_test_resultsManage control test results in Hyperproof. Test results document the outcome of control effectiveness testing. Actions: list, get, create, update.
hyperproof_proofManage proof documents in Hyperproof. Proof represents evidence (documents, screenshots, files) that demonstrate compliance with controls and requirements. Actions: list, get, create, update.
hyperproof_usersView users in Hyperproof organization. Read-only access to user information. Actions: list, get_me.
hyperproof_vendorsManage vendors and third-party organizations in Hyperproof. Track vendor relationships, risk assessments, and compliance status. Actions: list, get, create, update.
hyperproof_external_contactsManage external contacts in Hyperproof. External contacts are individuals outside the organization, such as vendor representatives or auditors. Actions: list, get, create, update.
hyperproof_labelsManage labels in Hyperproof. Labels are tags used to categorize and organize compliance objects like controls, risks, and tasks. Actions: list, get, create, update.
hyperproof_groupsManage user groups in Hyperproof. Groups allow organizing users for permissions and access control purposes. Actions: list, get, create, update.
hyperproof_rolesView roles in Hyperproof. Read-only access to role definitions and permissions. Actions: list.
hyperproof_task_statusesView task statuses in Hyperproof. Read-only access to task workflow states (e.g., Open, In Progress, Complete). Actions: list.
hyperproof_custom_fieldsManage custom fields in Hyperproof. Custom fields allow extending Hyperproof objects with organization-specific data fields. Actions: list, get, create, update.
hyperproof_custom_appsManage custom apps and integrations in Hyperproof. Custom apps allow extending Hyperproof functionality with custom integrations and workflows. Actions: list, get, create, update.

hyperproof_controls

Manage compliance controls in Hyperproof. Controls represent specific security or compliance requirements that organizations must implement and monitor. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesControl action: “list” = retrieve all controls with optional filters; “get” = retrieve single control by ID; “create” = add new control; “update” = modify existing control
controlIdstringNoControl ID (required for get, update). Example: “d88d505d-5199-11ee-a644-522476618ae8”
controlIdentifierstringNoUnique identifier for the control (required for create)
descriptionstringNoDescription of the control (required for create)
ownerstringNoUser ID who owns the control (required for create)
namestringNoName of the control
scopeIdstringNoUnique identifier of the scope associated with the control
notesstringNoAdditional notes about the control
domainNamestringNoName of the domain
domainIdstringNoIdentifier of the domain (update only)
implementationstringNoImplementation status
testingStatusstringNoTesting status
automationstringNoAutomation status
groupIdstringNoThe unique identifier of the group assigned to the control
customFieldsobject[]NoArray of custom field values
externalObjectIdsstring[]NoArray of external object IDs
freshnessPolicystringNoFreshness policy (update only)
freshForDurationstringNoDuration after which control becomes stale, ISO-8601 format (update only)
freshnessstringNoFreshness status (update only)
freshAsOfDatestringNoDate when marked fresh (update only)
freshAsOfNotestringNoNote when marked fresh (update only)
resetFreshnessNotestringNoNote when freshness is reset (update only)
testingDeficiencystring[]NoList of deficiencies (update only)
healthstringNoHealth status (update only)
overrideHealthbooleanNoOverride computed health (update only)
computeTestingStatusbooleanNoCompute testing status automatically (update only)
clearDomainbooleanNoClear domain association (update only)
clearGroupIdbooleanNoClear group assignment (update only)
statusstringNoObject status (update only) or filter for list
canLinkbooleanNoFilter for list: if true, only returns controls user can link to
expandScopesbooleanNoFor list: include scope controls as well as parent controls
expandTeamsbooleanNoFor list: include team controls as well as parent controls

hyperproof_tasks

Manage tasks in Hyperproof. Tasks represent action items that need to be completed as part of compliance workflows. Actions: list, get, create, update, list_comments, create_comment, update_comment, delete_comment. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesTask action: “list” = retrieve tasks with filters; “get” = retrieve single task by ID; “create” = add new task; “update” = modify task; “list_comments” = get all comments on task; “create_comment” = add comment to task; “update_comment” = modify comment; “delete_comment” = remove comment
taskIdstringNoTask ID (required for get, update, comment actions). Example: “ba50096d-bbfa-47af-94a7-092b0984cf35”
commentIdstringNoComment ID (required for update_comment, delete_comment)
commentTextFormattedstringNoComment text with formatting (required for create_comment)
isInternalCommentbooleanNoWhether comment is internal only
commentObjectIdstringNoRelated object ID for comment
commentObjectTypestringNoRelated object type for comment
titlestringNoTask title (required for create)
targetObjectIdstringNoTarget object ID (required for create)
targetObjectTypestringNoTarget object type (required for create, e.g., control, risk)
descriptionstringNoTask description
assigneeIdstringNoUser ID of task assignee (also used as list filter)
prioritystringNoTask priority (also used as list filter)
dueDatestringNoDue date (ISO-8601 format)
groupIdstringNoGroup ID assigned to the task
hasIntegrationbooleanNoWhether task has integration (create only)
targetIdstringNoTarget object ID (update only)
targetTypestringNoTarget object type (update only)
taskStatusIdstringNoTask status ID (update only)
clearGroupIdbooleanNoClear group assignment (update only)
statusstringNoFor list: filter tasks by status

hyperproof_risks

Manage organizational risks in Hyperproof. Risks represent potential threats or vulnerabilities that could impact compliance or security posture. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesRisk action: “list” = retrieve all risks; “get” = retrieve single risk by ID; “create” = add new risk; “update” = modify risk
riskIdstringNoRisk ID (required for get, update)
riskRegisterIdstringNoRisk register ID (required for create)
riskIdentifierstringNoHuman readable unique identifier (required for create)
descriptionstringNoRisk description (required for create)
ownerIdstringNoOwner user ID (required for create)
namestringNoName of the risk
categorystringNoRisk category
responsestringNoResponse to the risk
likelihoodLevelnumberNoInherent likelihood level (0-based index)
likelihoodRationalestringNoReasoning for likelihood level
impactLevelnumberNoInherent impact level (0-based index)
impactRationalestringNoReasoning for impact level
toleranceLevelnumberNoTolerance level (0-based index)
groupIdstringNoGroup ID assigned to risk
customFieldsobject[]NoArray of custom field values
residualLikelihoodLevelnumberNoResidual likelihood level (update only)
residualLikelihoodRationalestringNoReasoning for residual likelihood (update only)
residualImpactLevelnumberNoResidual impact level (update only)
residualImpactRationalestringNoReasoning for residual impact (update only)
clearGroupIdbooleanNoClear group assignment (update only)
clearCategorybooleanNoClear category (update only)
clearLikelihoodLevelbooleanNoClear likelihood level (update only)
clearImpactLevelbooleanNoClear impact level (update only)
clearToleranceLevelbooleanNoClear tolerance level (update only)
statusstringNoObject status (update only) or filter for list

hyperproof_issues

Manage compliance issues in Hyperproof. Issues represent identified problems or deficiencies that need resolution. Actions: list, get, create, update, list_comments, create_comment, update_comment, delete_comment. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesIssue action: “list” = retrieve all issues; “get” = retrieve single issue by ID; “create” = add new issue; “update” = modify issue; “list_comments” = get all comments on issue; “create_comment” = add comment to issue; “update_comment” = modify comment; “delete_comment” = remove comment
issueIdstringNoIssue ID (required for get, update, comment actions)
commentIdstringNoComment ID (required for update_comment, delete_comment)
commentTextFormattedstringNoComment text with formatting (required for create_comment)
isInternalCommentbooleanNoWhether comment is internal only
commentObjectIdstringNoRelated object ID for comment
commentObjectTypestringNoRelated object type for comment
summarystringNoIssue summary (required for create)
sourceObjectIdstringNoSource object ID (required for create)
sourceObjectTypestringNoSource object type (required for create)
descriptionstringNoIssue description
assigneeIdstringNoAssignee user ID
prioritystringNoIssue priority
dueDatestringNoDue date (ISO-8601 format)
customFieldsobject[]NoArray of custom field values
workItemStatusstringNoWork item status
impactstringNoImpact level
executiveSponsorstringNoExecutive sponsor user ID
businessOwnerstringNoBusiness owner user ID
actionPlanstringNoAction plan description
discoveredOnstringNoDate discovered (ISO-8601 format)
closedOnstringNoDate closed (ISO-8601 format)
effortLevelstringNoEffort level required
isPrivatebooleanNoWhether issue is private
groupIdstringNoGroup ID assigned to issue
clearDueDatebooleanNoClear due date (update only)
clearGroupIdbooleanNoClear group assignment (update only)
statusstringNoObject status (update only) or filter for list
severitystringNoFor list: filter issues by severity

hyperproof_policies

Manage organizational policies in Hyperproof. Policies define the rules and procedures that govern compliance and security practices. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesPolicy action: “list” = retrieve all policies; “get” = retrieve single policy by ID; “create” = add new policy; “update” = modify policy
policyIdstringNoPolicy ID (required for get, update)
namestringNoPolicy name (required for create)
descriptionstringNoPolicy description
ownerIdstringNoOwner user ID
customFieldsobject[]NoArray of custom field values
statusstringNoObject status (update only) or filter for list

hyperproof_policy_versions

Manage policy versions in Hyperproof. Track different versions of policies over time as they are updated and revised. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesPolicy version action: “list” = retrieve all versions; “get” = retrieve single version by ID; “create” = add new version; “update” = modify version
versionIdstringNoVersion ID (required for get, update)
policyIdstringNoPolicy ID (for filtering versions of specific policy)
dataobjectNoVersion data for create/update. Varies by policy

hyperproof_programs

Manage compliance programs in Hyperproof. Programs represent structured compliance initiatives like SOC 2, ISO 27001, or HIPAA compliance efforts. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesProgram action: “list” = retrieve all programs; “get” = retrieve single program by ID; “create” = add new program; “update” = modify program
programIdstringNoProgram ID (required for get, update)
descriptionstringNoProgram description (required for create)
namestringNoProgram name (required for create)
sectionRootIdstringNoSection root ID (required for create)
primaryContactIdstringNoPrimary contact user ID (required for create)
workStatusstringNoWork status (required for create)
sourceTemplateIdstringNoSource template ID (create only)
selectedBaselinesstring[]NoSelected baselines
jumpstartProgramIdsstring[]NoJumpstart program IDs (create only)
cloneProgramNamestringNoName of program to clone
frameworkLicenseNoticestringNoFramework license notice
overrideHealthbooleanNoOverride health status (update only)
overrideHealthHealthstringNoHealth status override value (update only)
overrideHealthBystringNoUser ID who overrode health (update only)
overrideHealthReasonstringNoReason for health override (update only)
baselineEnabledbooleanNoWhether baseline is enabled (update only)
frameworkVersionMappingIdstringNoFramework version mapping ID (update only)
removedRequirementIdsstring[]NoRequirement IDs to remove (update only)
updatedRequirementIdsstring[]NoRequirement IDs to update (update only)
isUpdateCompletebooleanNoWhether update is complete (update only)
statusstringNoFor list: filter programs by status

hyperproof_scopes

Manage compliance scopes in Hyperproof. Scopes define boundaries for compliance activities, such as departments, locations, or systems. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesScope action: “list” = retrieve all scopes; “get” = retrieve single scope by ID; “create” = add new scope; “update” = modify scope
scopeIdstringNoScope ID (required for get, update)
namestringNoScope name (required for create)
ownerstringNoOwner user ID (required for create)
descriptionstringNoScope description
parentIdstringNoParent scope ID
customFieldsobject[]NoArray of custom field values
statusstringNoObject status (update only)

hyperproof_scope_assignments

Associate objects with hierarchical scopes in Hyperproof. Creates or updates scope assignments for controls, risks, or other compatible objects. Actions: create. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesScope assignment action: “create” = create or update scope assignments (pass empty scopeIds array to remove assignments)
assignmentsobject[]YesArray of scope assignment objects (required for create)

hyperproof_questionnaires

Manage compliance questionnaires in Hyperproof. Questionnaires are used to collect information from vendors or assess compliance status. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesQuestionnaire action: “list” = retrieve all questionnaires; “get” = retrieve single questionnaire by ID; “create” = add new questionnaire; “update” = modify questionnaire
questionnaireIdstringNoQuestionnaire ID (required for get, update)
dataobjectNoQuestionnaire data. CREATE requires: name. CREATE optional: description, customFields. UPDATE optional: name, description, customFields, status (active|archived)
statusstringNoFor list: filter questionnaires by status

hyperproof_test_results

Manage control test results in Hyperproof. Test results document the outcome of control effectiveness testing. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesTest result action: “list” = retrieve all test results; “get” = retrieve single test result by ID; “create” = add new test result; “update” = modify test result
testResultIdstringNoTest result ID (required for get, update)
dataobjectNoTest result data. CREATE requires: testParentObjectId, testParentObjectType, testDate. CREATE optional: outcome (passed|failed|needsReview|inRemediation|resolved), testFrequency, testNotes, testerId, effectiveDate, expirationDate, customFields. UPDATE optional: all CREATE fields plus status
controlIdstringNoFor list: filter test results by control ID

hyperproof_proof

Manage proof documents in Hyperproof. Proof represents evidence (documents, screenshots, files) that demonstrate compliance with controls and requirements. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesProof action: “list” = retrieve all proof items; “get” = retrieve single proof by ID; “create” = upload new proof; “update” = modify proof metadata
proofIdstringNoProof ID (required for get, update)
dataobjectNoProof data. CREATE/UPDATE optional: filename, linkedObjectId, linkedObjectType, linkedObjectParentId, notes, isPrivate, nameOverride
linkedObjectIdstringNoFor list: filter proof by linked object ID (control, risk, etc.)
linkedObjectTypestringNoFor list: filter proof by linked object type

hyperproof_users

View users in Hyperproof organization. Read-only access to user information. Actions: list, get_me. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesUser action: “list” = retrieve all users in organization; “get_me” = retrieve current authenticated user info
expandstringNoComma-separated fields to expand. Supported: identityProviders, organizations (for get_me); identityProviders, organizationRoleId (for list)
includeDeactivatedbooleanNoFor list: include deactivated users in response

hyperproof_vendors

Manage vendors and third-party organizations in Hyperproof. Track vendor relationships, risk assessments, and compliance status. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesVendor action: “list” = retrieve all vendors; “get” = retrieve single vendor by ID; “create” = add new vendor; “update” = modify vendor
vendorIdstringNoVendor ID (required for get, update)
namestringNoVendor name (required for create)
ownerIdstringNoOwner user ID (required for create)
vendorStatusstringNoVendor status (required for create)
categorystringNoVendor category
groupIdstringNoGroup ID assigned to vendor
tolerancestringNoRisk tolerance level
contractStartDatestringNoContract start date (ISO-8601 format)
contractEndDatestringNoContract end date (ISO-8601 format)
contactsobject[]NoArray of external contacts {givenName, surname, email}
customFieldsobject[]NoArray of custom field values
clearCategorybooleanNoClear category (update only)
clearGroupIdbooleanNoClear group assignment (update only)
riskLevelstringNoRisk level (update only)
riskLevelIsOverriddenbooleanNoWhether risk level is overridden (update only)
riskLevelOverrideReasoningstringNoReasoning for risk override (update only)
clearContractStartDatebooleanNoClear contract start date (update only)
clearContractEndDatebooleanNoClear contract end date (update only)
freshnessPolicystringNoFreshness policy (update only)
freshForDurationstringNoDuration after which vendor becomes stale (update only)
freshnessstringNoFreshness status (update only)
freshAsOfDatestringNoDate marked fresh (update only)
freshAsOfNotestringNoNote when marked fresh (update only)
resetFreshnessNotestringNoNote when freshness reset (update only)
statusstringNoObject status (update only) or filter for list

hyperproof_external_contacts

Manage external contacts in Hyperproof. External contacts are individuals outside the organization, such as vendor representatives or auditors. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesContact action: “list” = retrieve all external contacts; “get” = retrieve single contact by ID; “create” = add new contact; “update” = modify contact
contactIdstringNoContact ID (required for get, update)
givenNamestringNoGiven name (required for create)
surnamestringNoSurname (required for create)
emailstringNoEmail address (required for create)
objectTypestringNoObject type to associate with (required for create)
objectIdstringNoObject ID to associate with (required for create)
vendorIdstringNoFor list: filter contacts by vendor ID

hyperproof_labels

Manage labels in Hyperproof. Labels are tags used to categorize and organize compliance objects like controls, risks, and tasks. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesLabel action: “list” = retrieve all labels; “get” = retrieve single label by ID; “create” = add new label; “update” = modify label
labelIdstringNoLabel ID (required for get, update)
namestringNoLabel name (required for create)
descriptionstringNoLabel description
freshnessPolicystringNoFreshness policy (update only)
freshForDurationstringNoDuration after which label becomes stale (update only)
freshnessstringNoFreshness status (update only)
freshAsOfDatestringNoDate marked fresh (update only)
freshAsOfNotestringNoNote when marked fresh (update only)
resetFreshnessNotestringNoNote when freshness reset (update only)
customFieldsobject[]NoArray of custom field values (update only)
statusstringNoObject status (update only)

hyperproof_groups

Manage user groups in Hyperproof. Groups allow organizing users for permissions and access control purposes. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesGroup action: “list” = retrieve all groups; “get” = retrieve single group by ID; “create” = add new group; “update” = modify group
groupIdstringNoGroup ID (required for get, update)
namestringNoGroup name (required for create)
groupLeadIdstringNoGroup lead user ID
userIdsstring[]NoArray of user IDs (create only)
clearGroupLeadbooleanNoClear group lead (update only)

hyperproof_roles

View roles in Hyperproof. Read-only access to role definitions and permissions. Actions: list. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesRole action: “list” = retrieve all roles

hyperproof_task_statuses

View task statuses in Hyperproof. Read-only access to task workflow states (e.g., Open, In Progress, Complete). Actions: list. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesTask status action: “list” = retrieve all task statuses

hyperproof_custom_fields

Manage custom fields in Hyperproof. Custom fields allow extending Hyperproof objects with organization-specific data fields. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesCustom field action: “list” = retrieve all custom fields; “get” = retrieve single field by ID; “create” = add new custom field; “update” = modify field definition
fieldIdstringNoField ID (required for get, update)
dataobjectNoField data. CREATE requires: name, type (text|number|date|user|textSingleSelect|textMultiSelect), availableOn (array of object types). CREATE optional: icon, isRequired, defaultTextValue, defaultDateValue, defaultNumberValue, numberFormat (decimal|percentage), options. UPDATE optional: name, icon, isRequired, defaultTextValue, defaultDateValue, defaultNumberValue, numberFormat, options, status (active|archived)
objectTypestringNoFor list: filter custom fields by object type (control, risk, task, etc.)

hyperproof_custom_apps

Manage custom apps and integrations in Hyperproof. Custom apps allow extending Hyperproof functionality with custom integrations and workflows. Actions: list, get, create, update. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesCustom app action: “list” = retrieve all custom apps; “get” = retrieve single app by ID; “create” = add new custom app; “update” = modify app configuration
appIdstringNoApp ID (required for get, update)
dataobjectNoApp data. CREATE requires: name, appType (webhook|api). CREATE optional: description, config, isActive. UPDATE optional: name, appType, description, config, isActive