{ "info": { "name": "Hyperproof API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authentication", "item": [ { "name": "Get OAuth Access Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "https://accounts.hyperproof.app/oauth/token", "protocol": "https", "host": [ "accounts", "hyperproof", "app" ], "path": [ "oauth", "token" ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" }, { "key": "client_id", "value": "{{client_id}}" }, { "key": "client_secret", "value": "{{client_secret}}" } ] }, "description": "Obtain an OAuth 2.0 access token using the client credentials flow." }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var json = pm.response.json();", "if (json.access_token) {", " pm.collectionVariables.set('access_token', json.access_token);", "}" ] } } ] } ] }, { "name": "Controls", "item": [ { "name": "Get Controls", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/controls/", "host": [ "{{base_url}}" ], "path": [ "controls" ], "query": [ { "key": "canLink", "value": "", "description": "If true, only returns controls to which the requesting user has link permission", "disabled": true }, { "key": "expandScopes", "value": "", "description": "If true, includes scope controls as well as parent controls", "disabled": true }, { "key": "expandTeams", "value": "", "description": "If true, includes team controls as well as parent controls", "disabled": true }, { "key": "status", "value": "", "description": "Filters results by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Controls\n\n**Operation ID:** get-controls" }, "response": [] }, { "name": "Add Control", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/controls/", "host": [ "{{base_url}}" ], "path": [ "controls" ], "query": [], "variable": [] }, "description": "Add Control\n\n**Operation ID:** add-control", "body": { "mode": "raw", "raw": "{\n \"controlIdentifier\": \"SOC2-P4.1.1\",\n \"name\": \"Include in the privacy notice the use of collected personal information\",\n \"description\": \"The privacy notice identifies the use of collected personal information.\",\n \"domainName\": \"Privacy\",\n \"implementation\": \"inProgress\",\n \"owner\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Controls Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/controls/filter", "host": [ "{{base_url}}" ], "path": [ "controls", "filter" ], "query": [], "variable": [] }, "description": "Get Controls Filtered\n\n**Operation ID:** get-controls-filtered", "body": { "mode": "raw", "raw": "{\n \"controlIds\": [\n \"23b806db-bad2-4f7a-b8d1-ac1177909992\",\n \"23b402db-bad2-4f7a-b8d1-ac1177909992\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Control Summaries", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/controls/summaries", "host": [ "{{base_url}}" ], "path": [ "controls", "summaries" ], "query": [ { "key": "canLink", "value": "", "description": "If true, only returns control summaries the requesting user has link permission for", "disabled": true }, { "key": "status", "value": "", "description": "Filters results by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Control Summaries\n\n**Operation ID:** get-control-summaries" }, "response": [] }, { "name": "Get Control", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/controls/:controlId", "host": [ "{{base_url}}" ], "path": [ "controls", ":controlId" ], "query": [], "variable": [ { "key": "controlId", "value": "", "description": "" } ] }, "description": "Get Control\n\n**Operation ID:** get-control" }, "response": [] }, { "name": "Update Control", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/controls/:controlId", "host": [ "{{base_url}}" ], "path": [ "controls", ":controlId" ], "query": [], "variable": [ { "key": "controlId", "value": "", "description": "" } ] }, "description": "Update Control\n\n**Operation ID:** update-control", "body": { "mode": "raw", "raw": "{\n \"name\": \"Include in the privacy notice the use of collected personal information\",\n \"description\": \"The privacy notice identifies the use of collected personal information.\",\n \"notes\": \"Meet quarterly to review\",\n \"freshnessPolicy\": \"manual\",\n \"freshForDuration\": \"PT720H\",\n \"freshness\": \"fresh\",\n \"freshAsOfDate\": \"2025-01-12T18:26:10.00.5365Z\",\n \"freshAsOfNote\": \"Updating expired control freshness\",\n \"implementation\": \"inProgress\",\n \"testingStatus\": \"effective\",\n \"owner\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Control Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/controls/:controlId/proof", "host": [ "{{base_url}}" ], "path": [ "controls", ":controlId", "proof" ], "query": [], "variable": [ { "key": "controlId", "value": "", "description": "" } ] }, "description": "Add Control Proof\n\n**Operation ID:** add-control-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] } ], "description": "Endpoints for Controls" }, { "name": "Custom Apps", "item": [ { "name": "Get Custom Apps", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/customapps/", "host": [ "{{base_url}}" ], "path": [ "customapps" ], "query": [], "variable": [] }, "description": "Get Custom Apps\n\n**Operation ID:** get-custom-apps" }, "response": [] }, { "name": "Add Custom App", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/customapps/", "host": [ "{{base_url}}" ], "path": [ "customapps" ], "query": [], "variable": [] }, "description": "Add Custom App\n\n**Operation ID:** add-custom-app" }, "response": [] }, { "name": "Get Custom App", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/customapps/:appId", "host": [ "{{base_url}}" ], "path": [ "customapps", ":appId" ], "query": [], "variable": [ { "key": "appId", "value": "", "description": "" } ] }, "description": "Get Custom App\n\n**Operation ID:** get-custom-app" }, "response": [] }, { "name": "Update Custom App", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/customapps/:appId", "host": [ "{{base_url}}" ], "path": [ "customapps", ":appId" ], "query": [], "variable": [ { "key": "appId", "value": "", "description": "" } ] }, "description": "Update Custom App\n\n**Operation ID:** update-custom-app" }, "response": [] }, { "name": "Delete Custom App", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/customapps/:appId", "host": [ "{{base_url}}" ], "path": [ "customapps", ":appId" ], "query": [], "variable": [ { "key": "appId", "value": "", "description": "" } ] }, "description": "Delete Custom App\n\n**Operation ID:** delete-custom-app" }, "response": [] }, { "name": "Get Custom App Events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/customapps/:appId/events", "host": [ "{{base_url}}" ], "path": [ "customapps", ":appId", "events" ], "query": [], "variable": [ { "key": "appId", "value": "", "description": "" } ] }, "description": "Get Custom App Events\n\n**Operation ID:** get-custom-app-events" }, "response": [] }, { "name": "Get Custom App Statistics", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/customapps/:appId/stats", "host": [ "{{base_url}}" ], "path": [ "customapps", ":appId", "stats" ], "query": [], "variable": [ { "key": "appId", "value": "", "description": "" } ] }, "description": "Get Custom App Statistics\n\n**Operation ID:** get-custom-app-statistics" }, "response": [] } ], "description": "Endpoints for Custom Apps" }, { "name": "Custom Fields", "item": [ { "name": "Get Custom Fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/customfields/", "host": [ "{{base_url}}" ], "path": [ "customfields" ], "query": [ { "key": "objectType", "value": "", "description": "Filters custom fields by the provided object type", "disabled": true } ], "variable": [] }, "description": "Get Custom Fields\n\n**Operation ID:** get-custom-fields" }, "response": [] } ], "description": "Endpoints for Custom Fields" }, { "name": "External Contacts", "item": [ { "name": "Get External Contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/externalcontacts/", "host": [ "{{base_url}}" ], "path": [ "externalcontacts" ], "query": [ { "key": "objectType", "value": "", "description": "If provided, returns all external contacts associated with the objectType", "disabled": true }, { "key": "objectId", "value": "", "description": "If provided, returns external contacts associated with the object. The objectType parameter is required if objectId is provided.", "disabled": true } ], "variable": [] }, "description": "Get External Contacts\n\n**Operation ID:** get-external-contacts" }, "response": [] }, { "name": "Add External Contact", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/externalcontacts/", "host": [ "{{base_url}}" ], "path": [ "externalcontacts" ], "query": [], "variable": [] }, "description": "Add External Contact\n\n**Operation ID:** add-external-contact", "body": { "mode": "raw", "raw": "{\n \"givenName\": \"John\",\n \"surname\": \"Deer\",\n \"email\": \"john.deer@example.com\",\n \"objectType\": \"vendor\",\n \"objectId\": \"e99e616e-6211-22ff-b755-633587729bf9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get External Contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/externalcontacts/:externalContactId", "host": [ "{{base_url}}" ], "path": [ "externalcontacts", ":externalContactId" ], "query": [], "variable": [ { "key": "externalContactId", "value": "", "description": "" } ] }, "description": "Get External Contact\n\n**Operation ID:** get-external-contact" }, "response": [] }, { "name": "Update External Contact", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/externalcontacts/:externalContactId", "host": [ "{{base_url}}" ], "path": [ "externalcontacts", ":externalContactId" ], "query": [], "variable": [ { "key": "externalContactId", "value": "", "description": "" } ] }, "description": "Update External Contact\n\n**Operation ID:** update-external-contact", "body": { "mode": "raw", "raw": "{\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete External Contact", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/externalcontacts/:externalContactId", "host": [ "{{base_url}}" ], "path": [ "externalcontacts", ":externalContactId" ], "query": [], "variable": [ { "key": "externalContactId", "value": "", "description": "" } ] }, "description": "Delete External Contact\n\n**Operation ID:** delete-external-contact" }, "response": [] } ], "description": "Endpoints for External Contacts" }, { "name": "Groups", "item": [ { "name": "Get Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups/", "host": [ "{{base_url}}" ], "path": [ "groups" ], "query": [ { "key": "status", "value": "", "description": "Comma-separated list of statuses (only active by default). Supported values are active and archived.", "disabled": true }, { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: userIds.", "disabled": true } ], "variable": [] }, "description": "Get Groups\n\n**Operation ID:** get-groups" }, "response": [] }, { "name": "Add Group", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/groups/", "host": [ "{{base_url}}" ], "path": [ "groups" ], "query": [], "variable": [] }, "description": "Add Group\n\n**Operation ID:** add-group", "body": { "mode": "raw", "raw": "{\n \"name\": \"Compliance Managers\",\n \"groupLeadId\": \"abcdef12-3456-7890-abcd-ef1234567890\",\n \"userIds\": [\n \"195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f\",\n \"12345678-1234-5678-1234-123456789012\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Group", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups/:groupId", "host": [ "{{base_url}}" ], "path": [ "groups", ":groupId" ], "query": [], "variable": [ { "key": "groupId", "value": "", "description": "" } ] }, "description": "Get Group\n\n**Operation ID:** get-group" }, "response": [] }, { "name": "Update Group", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/groups/:groupId", "host": [ "{{base_url}}" ], "path": [ "groups", ":groupId" ], "query": [], "variable": [ { "key": "groupId", "value": "", "description": "" } ] }, "description": "Update Group\n\n**Operation ID:** update-group", "body": { "mode": "raw", "raw": "{\n \"name\": \"Compliance Managers\",\n \"groupLeadId\": \"abcdef12-3456-7890-abcd-ef1234567890\",\n \"clearGroupLead\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Group Members", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups/users", "host": [ "{{base_url}}" ], "path": [ "groups", "users" ], "query": [ { "key": "status", "value": "", "description": "Comma-separated list of statuses (only active by default). Supported values are active and archived.", "disabled": true } ], "variable": [] }, "description": "Get Group Members\n\n**Operation ID:** get-all-group-members" }, "response": [] }, { "name": "Get Group Members", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups/:groupId/users", "host": [ "{{base_url}}" ], "path": [ "groups", ":groupId", "users" ], "query": [], "variable": [ { "key": "groupId", "value": "", "description": "" } ] }, "description": "Get Group Members\n\n**Operation ID:** get-group-members" }, "response": [] }, { "name": "Add Group Member", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/groups/:groupId/users", "host": [ "{{base_url}}" ], "path": [ "groups", ":groupId", "users" ], "query": [], "variable": [ { "key": "groupId", "value": "", "description": "" } ] }, "description": "Add Group Member\n\n**Operation ID:** add-group-member", "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove Group Members", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/groups/:groupId/users/delete", "host": [ "{{base_url}}" ], "path": [ "groups", ":groupId", "users", "delete" ], "query": [], "variable": [ { "key": "groupId", "value": "", "description": "" } ] }, "description": "Remove Group Members\n\n**Operation ID:** remove-group-members", "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"195032c4-0a2b-4f3e-8d5f-1a2b3c4d5e6f 12345678-1234-5678-1234-123456789012\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Groups" }, { "name": "Issues", "item": [ { "name": "Add Issue", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/issues/", "host": [ "{{base_url}}" ], "path": [ "issues" ], "query": [], "variable": [] }, "description": "Add Issue\n\n**Operation ID:** add-issue", "body": { "mode": "raw", "raw": "{\n \"summary\": \"Incorrect policy implementation\",\n \"description\": \"The policy implementation does not match standard operating procedures\",\n \"assigneeId\": \"e99e616e-6211-22ff-b755-633587729bf9\",\n \"workItemStatus\": \"notStarted\",\n \"priority\": \"high\",\n \"dueDate\": \"2024-12-24T00:00:01Z\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"John Smith\"\n }\n ],\n \"source\": {\n \"objectId\": \"f06fe159-e7c1-4b42-8715-5615ff50b29c\",\n \"objectType\": \"audit\"\n },\n \"impact\": \"medium\",\n \"executiveSponsor\": \"d3636cb0-10bf-45e9-abaa-b0efba75965d\",\n \"businessOwner\": \"4b81e4aa-7577-4579-b05c-bcc76af8f2f1\",\n \"actionPlan\": \"Update the implementation to modern standards\",\n \"discoveredOn\": \"2024-11-01T00:00:01Z\",\n \"closedOn\": \"2024-11-02T00:00:01Z\",\n \"effortLevel\": \"highest\",\n \"isPrivate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Issues Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/issues/filter", "host": [ "{{base_url}}" ], "path": [ "issues", "filter" ], "query": [], "variable": [] }, "description": "Get Issues Filtered\n\n**Operation ID:** get-issues-filtered", "body": { "mode": "raw", "raw": "{\n \"sourceObjects\": [\n {\n \"objectId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"objectType\": \"control\"\n }\n ],\n \"issueIds\": [\n \"ba50096d-bbfa-47af-94a7-092b0984cf35\"\n ],\n \"assigneeIds\": [\n \"ad21d858-c271-4c6d-8780-fecf6b16e534\"\n ],\n \"workItemStatus\": \"inProgress\",\n \"createdAfter\": \"2020-12-10T20:00:00Z\",\n \"createdBefore\": \"2020-12-11T20:00:00Z\",\n \"modifiedAfter\": \"2020-12-17T20:00:00Z\",\n \"modifiedBefore\": \"2020-12-18T20:00:00Z\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Issue", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Get Issue\n\n**Operation ID:** get-issue" }, "response": [] }, { "name": "Update Issue", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Update Issue\n\n**Operation ID:** update-issue", "body": { "mode": "raw", "raw": "{\n \"summary\": \"Incorrect policy implementation\",\n \"description\": \"The policy implementation does not match standard operating procedures\",\n \"assigneeId\": \"e99e616e-6211-22ff-b755-633587729bf9\",\n \"workItemStatus\": \"notStarted\",\n \"priority\": \"high\",\n \"dueDate\": \"2024-12-24T00:00:01Z\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"John Smith\"\n }\n ],\n \"clearDueDate\": false,\n \"source\": {\n \"objectId\": \"f06fe159-e7c1-4b42-8715-5615ff50b29c\",\n \"objectType\": \"audit\"\n },\n \"impact\": \"medium\",\n \"executiveSponsor\": \"d3636cb0-10bf-45e9-abaa-b0efba75965d\",\n \"businessOwner\": \"4b81e4aa-7577-4579-b05c-bcc76af8f2f1\",\n \"actionPlan\": \"Update the implementation to modern standards\",\n \"discoveredOn\": \"2024-11-01T00:00:01Z\",\n \"closedOn\": \"2024-11-02T00:00:01Z\",\n \"effortLevel\": \"highest\",\n \"isPrivate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Issue Proof Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/proof", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "proof" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Get Issue Proof Metadata\n\n**Operation ID:** get-issue-proof-metadata" }, "response": [] }, { "name": "Add Issue Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/proof", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "proof" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Add Issue Proof\n\n**Operation ID:** add-issue-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] }, { "name": "Get Issue Comments", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/comments", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "comments" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Get Issue Comments\n\n**Operation ID:** get-issue-comments" }, "response": [] }, { "name": "Add Issue Comment", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/comments", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "comments" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" } ] }, "description": "Add Issue Comment\n\n**Operation ID:** add-issue-comment", "body": { "mode": "raw", "raw": "{\n \"commentTextFormatted\": \"The audit is completed.\",\n \"isInternalComment\": true,\n \"objectId\": \"82d7c228-8bcd-11e9-a94b-ab3de849498z\",\n \"objectType\": \"risk\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Issue Comment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/comments/:commentId", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "comments", ":commentId" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" }, { "key": "commentId", "value": "", "description": "" } ] }, "description": "Update Issue Comment\n\n**Operation ID:** update-issue-comment", "body": { "mode": "raw", "raw": "{\n \"commentTextFormatted\": \"The audit is completed.\",\n \"isInternalComment\": true,\n \"objectId\": \"82d7c228-8bcd-11e9-a94b-ab3de849498z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Issue Comment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/issues/:issueId/comments/:commentId", "host": [ "{{base_url}}" ], "path": [ "issues", ":issueId", "comments", ":commentId" ], "query": [], "variable": [ { "key": "issueId", "value": "", "description": "" }, { "key": "commentId", "value": "", "description": "" } ] }, "description": "Delete Issue Comment\n\n**Operation ID:** delete-issue-comment" }, "response": [] } ], "description": "Endpoints for Issues" }, { "name": "Labels", "item": [ { "name": "Get Labels", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/labels/", "host": [ "{{base_url}}" ], "path": [ "labels" ], "query": [ { "key": "canLink", "value": "", "description": "If true, only returns labels to which the requesting user has link permission", "disabled": true }, { "key": "status", "value": "", "description": "Filters resultsby the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Labels\n\n**Operation ID:** get-labels" }, "response": [] }, { "name": "Add Label", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/labels/", "host": [ "{{base_url}}" ], "path": [ "labels" ], "query": [], "variable": [] }, "description": "Add Label\n\n**Operation ID:** add-label", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acceptable use of assets\",\n \"description\": \"List of acceptable uses of assets by company employees.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Label Summaries", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/labels/summaries", "host": [ "{{base_url}}" ], "path": [ "labels", "summaries" ], "query": [ { "key": "canLink", "value": "", "description": "If true, only returns labels the requesting user has link permission for", "disabled": true }, { "key": "status", "value": "", "description": "Filters results by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Label Summaries\n\n**Operation ID:** get-label-summaries" }, "response": [] }, { "name": "Get Label", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/labels/:labelId", "host": [ "{{base_url}}" ], "path": [ "labels", ":labelId" ], "query": [], "variable": [ { "key": "labelId", "value": "", "description": "" } ] }, "description": "Get Label\n\n**Operation ID:** get-label" }, "response": [] }, { "name": "Update Label", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/labels/:labelId", "host": [ "{{base_url}}" ], "path": [ "labels", ":labelId" ], "query": [], "variable": [ { "key": "labelId", "value": "", "description": "" } ] }, "description": "Updates an existing label with new values.\n\n**Operation ID:** update-label", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acceptable use of assets\",\n \"description\": \"List of acceptable uses of assets by company employees.\",\n \"freshnessPolicy\": \"manual\",\n \"freshForDuration\": \"PT720H\",\n \"freshness\": \"fresh\",\n \"freshAsOfDate\": \"2025-01-12T18:26:10.00.5365Z\",\n \"freshAsOfNote\": \"Updating expired label freshness\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"value\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Label Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/labels/:labelId/proof", "host": [ "{{base_url}}" ], "path": [ "labels", ":labelId", "proof" ], "query": [], "variable": [ { "key": "labelId", "value": "", "description": "" } ] }, "description": "Add Label Proof\n\n**Operation ID:** add-label-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] } ], "description": "Endpoints for Labels" }, { "name": "Mcp", "item": [ { "name": "MCP Request", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/", "host": [ "{{base_url}}" ], "path": [], "query": [], "variable": [] }, "description": "Sends a Model Context Protocol request to the Hyperproof MCP server.\n\n**Operation ID:** mcp-request", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Mcp" }, { "name": "Policies", "item": [ { "name": "Get Policies", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/policies/", "host": [ "{{base_url}}" ], "path": [ "policies" ], "query": [ { "key": "status", "value": "", "description": "Filters policies by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Policies\n\n**Operation ID:** get-policies" }, "response": [] }, { "name": "Add Policy", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/policies/", "host": [ "{{base_url}}" ], "path": [ "policies" ], "query": [], "variable": [] }, "description": "Add Policy\n\n**Operation ID:** add-policy", "body": { "mode": "raw", "raw": "{\n \"name\": \"Password Policy\",\n \"description\": \"Password acceptance criteria.\",\n \"ownerId\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"John Smith\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Policies", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/policies/", "host": [ "{{base_url}}" ], "path": [ "policies" ], "query": [], "variable": [] }, "description": "Update Policies\n\n**Operation ID:** update-policies", "body": { "mode": "raw", "raw": "{\n \"policyIds\": [\n \"8f3fa15f-6d4b-4bd3-a689-aff421aa0552\"\n ],\n \"patch\": {\n \"name\": \"Password Policy\",\n \"description\": \"Password acceptance criteria.\",\n \"ownerId\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"John Smith\"\n }\n ],\n \"status\": \"active\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Policy", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/policies/:policyId", "host": [ "{{base_url}}" ], "path": [ "policies", ":policyId" ], "query": [], "variable": [ { "key": "policyId", "value": "", "description": "" } ] }, "description": "Get Policy\n\n**Operation ID:** get-policy" }, "response": [] }, { "name": "Update Policy", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/policies/:policyId", "host": [ "{{base_url}}" ], "path": [ "policies", ":policyId" ], "query": [], "variable": [ { "key": "policyId", "value": "", "description": "" } ] }, "description": "Update Policy\n\n**Operation ID:** update-policy", "body": { "mode": "raw", "raw": "{\n \"name\": \"Password Policy\",\n \"description\": \"Password acceptance criteria.\",\n \"ownerId\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"John Smith\"\n }\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Policies" }, { "name": "Policy Versions", "item": [ { "name": "Get Policy Versions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/policyversions/", "host": [ "{{base_url}}" ], "path": [ "policyversions" ], "query": [ { "key": "policyId", "value": "", "description": "Gets policy versions by this policy ID.", "disabled": true } ], "variable": [] }, "description": "Get Policy Versions\n\n**Operation ID:** get-policy-versions" }, "response": [] }, { "name": "Add Policy Version", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/policyversions/", "host": [ "{{base_url}}" ], "path": [ "policyversions" ], "query": [ { "key": "policyId", "value": "", "description": "Gets policy versions by this policy ID.", "disabled": true } ], "variable": [] }, "description": "Add Policy Version\n\n**Operation ID:** add-policy-version", "body": { "mode": "raw", "raw": "{\n \"name\": \"Password Policy Version\",\n \"revisionStatus\": \"approval\",\n \"nextRevisionDate\": \"2025-06-15T18:26:10.005365Z\",\n \"nextReviewDate\": \"2025-06-16T18:26:10.005365Z\",\n \"approvedDate\": \"2025-06-15T18:26:10.005365Z\",\n \"retiredDate\": \"2025-06-15T18:26:10.005365Z\",\n \"effectiveDate\": \"2025-06-12T18:26:10.005365Z\",\n \"publishedUrl\": \"www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Policy Version", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/policyversions/:versionId", "host": [ "{{base_url}}" ], "path": [ "policyversions", ":versionId" ], "query": [], "variable": [ { "key": "versionId", "value": "", "description": "" } ] }, "description": "Get Policy Version\n\n**Operation ID:** get-policy-version" }, "response": [] }, { "name": "Update a single policy version", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/policyversions/:versionId", "host": [ "{{base_url}}" ], "path": [ "policyversions", ":versionId" ], "query": [ { "key": "policyId", "value": "", "description": "Gets policy versions by this policy ID.", "disabled": true } ], "variable": [ { "key": "versionId", "value": "", "description": "" } ] }, "description": "Update a single policy version\n\n**Operation ID:** update-policy-version", "body": { "mode": "raw", "raw": "{\n \"name\": \"Password Policy Version\",\n \"revisionStatus\": \"approval\",\n \"status\": \"active\",\n \"nextRevisionDate\": \"2025-06-15T18:26:10.005365Z\",\n \"nextReviewDate\": \"2025-06-16T18:26:10.005365Z\",\n \"approvedDate\": \"2025-06-15T18:26:10.005365Z\",\n \"retiredDate\": \"2025-06-15T18:26:10.005365Z\",\n \"effectiveDate\": \"2025-06-12T18:26:10.005365Z\",\n \"publishedUrl\": \"www.google.com\",\n \"shareLink\": \"www.google.com\",\n \"ownerId\": \"82d7c228-8bcd-11e9-a94b-ab3de8494987\",\n \"clearNextReviewDate\": false,\n \"clearNextRevisionDate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Policy Version Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/policyversions/:versionId/proof", "host": [ "{{base_url}}" ], "path": [ "policyversions", ":versionId", "proof" ], "query": [ { "key": "policyId", "value": "", "description": "Unique ID of the policy version's parent policy.", "disabled": true } ], "variable": [ { "key": "versionId", "value": "", "description": "" } ] }, "description": "Add Policy Version Proof\n\n**Operation ID:** add-policy-version-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] }, { "name": "Add a Policy Version Document", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/policyversions/:versionId/documents", "host": [ "{{base_url}}" ], "path": [ "policyversions", ":versionId", "documents" ], "query": [ { "key": "policyId", "value": "", "description": "Unique ID of the policy version's parent policy.", "disabled": true } ], "variable": [ { "key": "versionId", "value": "", "description": "" } ] }, "description": "Add a Policy Version Document\n\n**Operation ID:** add-policy-version-document", "body": { "mode": "formdata", "formdata": [] } }, "response": [] } ], "description": "Endpoints for Policy Versions" }, { "name": "Programs", "item": [ { "name": "Get Programs", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/programs/", "host": [ "{{base_url}}" ], "path": [ "programs" ], "query": [ { "key": "status", "value": "", "description": "Filters results by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Programs\n\n**Operation ID:** get-programs" }, "response": [] }, { "name": "Add Program", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/programs/", "host": [ "{{base_url}}" ], "path": [ "programs" ], "query": [], "variable": [] }, "description": "Add Program\n\n**Operation ID:** add-program", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"sectionRootId\": \"f3bb12de-bd01-4456-965d-57ee221806d3\",\n \"sourceTemplateId\": \"d6851a9e-f9b9-4de9-b936-f7660fd7480e\",\n \"primaryContactId\": \"3963a7cc-dba9-4f5b-bda9-3a5572453334\",\n \"workStatus\": \"defining\",\n \"selectedBaselines\": [\n \"low\"\n ],\n \"jumpstartProgramIds\": [\n \"string\"\n ],\n \"cloneProgramName\": \"string\",\n \"frameworkLicenseNotice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a Program", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/programs/:programId", "host": [ "{{base_url}}" ], "path": [ "programs", ":programId" ], "query": [], "variable": [ { "key": "programId", "value": "", "description": "" } ] }, "description": "Get a Program\n\n**Operation ID:** get-program" }, "response": [] }, { "name": "Update a Program", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/programs/:programId", "host": [ "{{base_url}}" ], "path": [ "programs", ":programId" ], "query": [], "variable": [ { "key": "programId", "value": "", "description": "" } ] }, "description": "Update a Program\n\n**Operation ID:** update-program", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"description\": \"string\",\n \"primaryContactId\": \"7e20bd4c-32e1-463e-907e-0a4583a9b842\",\n \"workStatus\": \"defining\",\n \"overrideHealth\": true,\n \"overrideHealthHealth\": \"critical\",\n \"overrideHealthById\": \"d3c7269a-d19f-4a48-ae85-01543d1ed2fc\",\n \"overrideHealthReason\": \"string\",\n \"selectedBaselines\": [\n \"low\"\n ],\n \"baselineEnabled\": true,\n \"frameworkVersionMappingId\": \"2fb934c1-783d-48e5-8ed5-b01c31bdd44d\",\n \"removedRequirementIds\": [\n \"string\"\n ],\n \"updatedRequirementIds\": [\n \"string\"\n ],\n \"cloneProgramName\": \"string\",\n \"isUpdateComplete\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Programs" }, { "name": "Proof", "item": [ { "name": "Get Proof Metadata Collection", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/proof/", "host": [ "{{base_url}}" ], "path": [ "proof" ], "query": [ { "key": "limit", "value": "", "description": "The maximum number of proof to return.", "disabled": true }, { "key": "sortBy", "value": "", "description": "The proof property to use when sorting the result.", "disabled": true }, { "key": "sortDirection", "value": "", "description": "The direction the data should be sorted.", "disabled": true }, { "key": "nextToken", "value": "", "description": "Token returned from a previous call to retrieve proof.", "disabled": true }, { "key": "objectType", "value": "", "description": "Linked object type.", "disabled": true }, { "key": "objectId", "value": "", "description": "Unique identifier of the linked object.", "disabled": true } ], "variable": [] }, "description": "Get Proof Metadata Collection\n\n**Operation ID:** get-proof-metadata-collection" }, "response": [] }, { "name": "Add Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/proof/", "host": [ "{{base_url}}" ], "path": [ "proof" ], "query": [], "variable": [] }, "description": "Add Proof\n\n**Operation ID:** add-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] }, { "name": "Get Proof Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/proof/:proofId", "host": [ "{{base_url}}" ], "path": [ "proof", ":proofId" ], "query": [], "variable": [ { "key": "proofId", "value": "", "description": "" } ] }, "description": "Get Proof Metadata\n\n**Operation ID:** get-proof-metadata" }, "response": [] }, { "name": "Update Proof", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/proof/:proofId", "host": [ "{{base_url}}" ], "path": [ "proof", ":proofId" ], "query": [], "variable": [ { "key": "proofId", "value": "", "description": "" } ] }, "description": "Update Proof\n\n**Operation ID:** update-proof", "body": { "mode": "raw", "raw": "{\n \"isPrivate\": false,\n \"schema\": {\n \"class\": \"CsvFileSchema\",\n \"fields\": [\n {\n \"name\": \"Name\",\n \"type\": \"text\"\n },\n {\n \"name\": \"Access Level\",\n \"type\": \"number\"\n },\n {\n \"name\": \"Last Access\",\n \"type\": \"date\"\n },\n {\n \"name\": \"MFA Enabled\",\n \"type\": \"boolean\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Gets the contents of a proof.", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/proof/:proofId/contents", "host": [ "{{base_url}}" ], "path": [ "proof", ":proofId", "contents" ], "query": [ { "key": "version", "value": "", "description": "The proof version to retrieve.", "disabled": true } ], "variable": [ { "key": "proofId", "value": "", "description": "" } ] }, "description": "Gets the contents of a proof.\n\n**Operation ID:** get-proof-contents" }, "response": [] }, { "name": "Add Proof Version", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/proof/:proofId/versions", "host": [ "{{base_url}}" ], "path": [ "proof", ":proofId", "versions" ], "query": [], "variable": [ { "key": "proofId", "value": "", "description": "" } ] }, "description": "Add Proof Version\n\n**Operation ID:** add-proof-version", "body": { "mode": "formdata", "formdata": [] } }, "response": [] } ], "description": "Endpoints for Proof" }, { "name": "Questionnaires", "item": [ { "name": "Get Questionnaires", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/questionnaires/", "host": [ "{{base_url}}" ], "path": [ "questionnaires" ], "query": [ { "key": "status", "value": "", "description": "Filters results by the provided object status", "disabled": true } ], "variable": [] }, "description": "Get Questionnaires\n\n**Operation ID:** get-questionnaires" }, "response": [] }, { "name": "Get Questionnaire", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/questionnaires/:questionnaireId", "host": [ "{{base_url}}" ], "path": [ "questionnaires", ":questionnaireId" ], "query": [], "variable": [ { "key": "questionnaireId", "value": "", "description": "" } ] }, "description": "Get Questionnaire\n\n**Operation ID:** get-questionnaire" }, "response": [] }, { "name": "Send Questionnaire", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/questionnaires/:questionnaireId/send", "host": [ "{{base_url}}" ], "path": [ "questionnaires", ":questionnaireId", "send" ], "query": [], "variable": [ { "key": "questionnaireId", "value": "", "description": "" } ] }, "description": "Send Questionnaire\n\n**Operation ID:** send-questionnaire", "body": { "mode": "raw", "raw": "{\n \"invitedToId\": \"42310868-81f9-48c3-b68a-6582495c36b7\",\n \"objectInfo\": [\n {\n \"objectId\": \"859c5f4f-734d-4c7f-9673-efa7f30e4da8\",\n \"ownerId\": \"75c7a61b-0366-48d4-843a-e9ff69292793\",\n \"respondentType\": \"owner\"\n }\n ],\n \"objectType\": \"vendor\",\n \"version\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Questionnaire Invitations Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/questionnaires/invitations/filter", "host": [ "{{base_url}}" ], "path": [ "questionnaires", "invitations", "filter" ], "query": [], "variable": [] }, "description": "Get Questionnaire Invitations Filtered\n\n**Operation ID:** get-questionnaire-invitations-filtered", "body": { "mode": "raw", "raw": "{\n \"questionnaireIds\": [\n \"a3f96b88-51a8-4db0-9403-a40b8b6d92e4\",\n \"cf09a1f6-3bcc-4e71-9c56-11bb83bf57d6\"\n ],\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Send Questionnaire Reminder", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/questionnaires/:questionnaireId/invitations/:invitationId/remind", "host": [ "{{base_url}}" ], "path": [ "questionnaires", ":questionnaireId", "invitations", ":invitationId", "remind" ], "query": [], "variable": [ { "key": "questionnaireId", "value": "", "description": "" }, { "key": "invitationId", "value": "", "description": "" } ] }, "description": "Send Questionnaire Reminder\n\n**Operation ID:** send-questionnaire-reminder" }, "response": [] }, { "name": "Get Questionnaire Questions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/questionnaires/:questionnaireId/questions", "host": [ "{{base_url}}" ], "path": [ "questionnaires", ":questionnaireId", "questions" ], "query": [ { "key": "version", "value": "", "description": "The version of the questionnaire to retrieve questions from", "disabled": true } ], "variable": [ { "key": "questionnaireId", "value": "", "description": "" } ] }, "description": "Get Questionnaire Questions\n\n**Operation ID:** get-questionnaire-questions" }, "response": [] } ], "description": "Endpoints for Questionnaires" }, { "name": "Risks", "item": [ { "name": "Get Risks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/risks/", "host": [ "{{base_url}}" ], "path": [ "risks" ], "query": [ { "key": "riskRegisterId", "value": "", "description": "Unique ID of the risk register", "disabled": true }, { "key": "status", "value": "", "description": "Comma separated list of statuses to filter risks. Supported values: active, archived", "disabled": true }, { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: linkedControls.", "disabled": true } ], "variable": [] }, "description": "Get Risks\n\n**Operation ID:** get-risks" }, "response": [] }, { "name": "Add Risk", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/risks/", "host": [ "{{base_url}}" ], "path": [ "risks" ], "query": [], "variable": [] }, "description": "Add Risk\n\n**Operation ID:** add-risk", "body": { "mode": "raw", "raw": "{\n \"riskRegisterId\": \"23b806fb-bad2-4f7a-b8d1-ac1177909992\",\n \"riskIdentifier\": \"RA-5\",\n \"name\": \"Gas Risk\",\n \"description\": \"Risks of gas and electricity\",\n \"category\": \"Controls Program - Customer Operations\",\n \"response\": \"accept\",\n \"likelihoodLevel\": 1,\n \"likelihoodRationale\": \"security\",\n \"impactLevel\": 2,\n \"impactRationale\": \"cyber\",\n \"toleranceLevel\": 0,\n \"groupId\": \"12ab806f-bad2-4f7a-b8d1-ac117790999a\",\n \"ownerId\": \"23b806db-bad2-4f7a-b8d1-ac117790999b\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Risks Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/risks/filter", "host": [ "{{base_url}}" ], "path": [ "risks", "filter" ], "query": [ { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: linkedControls.", "disabled": true } ], "variable": [] }, "description": "Get Risks Filtered\n\n**Operation ID:** get-risks-filtered", "body": { "mode": "raw", "raw": "{\n \"riskIds\": [\n \"23b806db-bad2-4f7a-b8d1-ac1177909992\",\n \"23b402db-bad2-4f7a-b8d1-ac1177909992\"\n ],\n \"modifiedAfter\": \"2020-12-17T20:00:00Z\",\n \"status\": \"active\",\n \"riskStage\": \"operating\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Risk", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/risks/:riskId", "host": [ "{{base_url}}" ], "path": [ "risks", ":riskId" ], "query": [ { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: linkedControls.", "disabled": true } ], "variable": [ { "key": "riskId", "value": "", "description": "" } ] }, "description": "Get Risk\n\n**Operation ID:** get-risk" }, "response": [] }, { "name": "Update Risk", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/risks/:riskId", "host": [ "{{base_url}}" ], "path": [ "risks", ":riskId" ], "query": [], "variable": [ { "key": "riskId", "value": "", "description": "" } ] }, "description": "Update Risk\n\n**Operation ID:** update-risk", "body": { "mode": "raw", "raw": "{\n \"riskIdentifier\": \"RA-5\",\n \"name\": \"Gas Risk\",\n \"description\": \"Risks of gas and electricity\",\n \"category\": \"Controls Program - Customer Operations\",\n \"response\": \"accept\",\n \"ownerId\": \"23b806db-bad2-4f7a-b8d1-ac117790999b\",\n \"status\": \"archived\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Risks" }, { "name": "Role Assignments", "item": [ { "name": "Add Role Assignment", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/roleassignments/", "host": [ "{{base_url}}" ], "path": [ "roleassignments" ], "query": [], "variable": [] }, "description": "Add Role Assignment\n\n**Operation ID:** add-role-assignment", "body": { "mode": "raw", "raw": "{\n \"roleKind\": \"manager\",\n \"principalId\": \"456e7890-e89b-12d3-a456-426614174000\",\n \"principalType\": \"user\",\n \"targetObjectId\": \"321e0987-e89b-12d3-a456-426614174000\",\n \"targetObjectType\": \"control\",\n \"message\": \"Adding you as control manager\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Role Assignments Filtered", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/roleassignments/filter", "host": [ "{{base_url}}" ], "path": [ "roleassignments", "filter" ], "query": [], "variable": [] }, "description": "Get Role Assignments Filtered\n\n**Operation ID:** get-role-assignments-filtered", "body": { "mode": "raw", "raw": "{\n \"objectType\": \"control\",\n \"userIds\": [\n \"456e7890-e89b-12d3-a456-426614174000\"\n ],\n \"directAssignmentsOnly\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Role Assignment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/roleassignments/:id", "host": [ "{{base_url}}" ], "path": [ "roleassignments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Update Role Assignment\n\n**Operation ID:** update-role-assignment", "body": { "mode": "raw", "raw": "{\n \"roleKind\": \"contributor\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Role Assignment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/roleassignments/:id", "host": [ "{{base_url}}" ], "path": [ "roleassignments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "" } ] }, "description": "Delete Role Assignment\n\n**Operation ID:** delete-role-assignment" }, "response": [] } ], "description": "Endpoints for Role Assignments" }, { "name": "Roles", "item": [ { "name": "Get Roles", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/roles/", "host": [ "{{base_url}}" ], "path": [ "roles" ], "query": [], "variable": [] }, "description": "Get Roles\n\n**Operation ID:** get-roles" }, "response": [] } ], "description": "Endpoints for Roles" }, { "name": "Scope Assignments", "item": [ { "name": "Scope Assignments", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/scopeassignments/", "host": [ "{{base_url}}" ], "path": [ "scopeassignments" ], "query": [], "variable": [] }, "description": "Creates or updates hierarchical scope assignments in a Hyperproof organization.\n\n**Operation ID:** add-scope-assignments", "body": { "mode": "raw", "raw": "[\n {\n \"objectType\": \"control\",\n \"objectId\": \"6c006c16-9349-4df2-80be-64895c27d7bb\",\n \"scopeIds\": [\n \"2128c0da-140e-460d-974c-8cd20401afbc\",\n \"ef11b12c-3b75-4a19-b212-72dcbe010fe7\"\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Scope Assignments" }, { "name": "Scopes", "item": [ { "name": "Get Scopes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/scopes/", "host": [ "{{base_url}}" ], "path": [ "scopes" ], "query": [], "variable": [] }, "description": "Get Scopes\n\n**Operation ID:** get-scopes" }, "response": [] }, { "name": "Create Scope", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/scopes/", "host": [ "{{base_url}}" ], "path": [ "scopes" ], "query": [], "variable": [] }, "description": "Create Scope\n\n**Operation ID:** create-scope", "body": { "mode": "raw", "raw": "{\n \"name\": \"New Scope\",\n \"owner\": \"23b806db-bad2-4f7a-b8d1-ac117790999b\",\n \"parentId\": \"b7c74ee5-7c13-41a3-9395-d789a13cb249\",\n \"description\": \"A newly created scope\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk Update Scopes", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/scopes/", "host": [ "{{base_url}}" ], "path": [ "scopes" ], "query": [], "variable": [] }, "description": "Bulk Update Scopes\n\n**Operation ID:** bulk-update-scopes", "body": { "mode": "raw", "raw": "{\n \"scopeIds\": [\n \"cb1a06f4-8ed9-4614-a17b-f8671194687e\"\n ],\n \"patch\": {\n \"name\": \"Acme\",\n \"owner\": \"402f37f8-6054-4138-be1f-9b22ec08a86b\",\n \"description\": \"The Acme Corp scope\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Filter Scopes", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/scopes/filter", "host": [ "{{base_url}}" ], "path": [ "scopes", "filter" ], "query": [], "variable": [] }, "description": "Gets the set of scopes matching the supplied filter.\n\n**Operation ID:** get-scopes-filtered", "body": { "mode": "raw", "raw": "{\n \"programIds\": [\n \"e8e2a5b6-767d-4345-86b9-a9d12a5836ee\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Scope", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/scopes/:scopeId", "host": [ "{{base_url}}" ], "path": [ "scopes", ":scopeId" ], "query": [], "variable": [ { "key": "scopeId", "value": "", "description": "" } ] }, "description": "Get Scope\n\n**Operation ID:** get-scope" }, "response": [] }, { "name": "Update Scope", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/scopes/:scopeId", "host": [ "{{base_url}}" ], "path": [ "scopes", ":scopeId" ], "query": [], "variable": [ { "key": "scopeId", "value": "", "description": "" } ] }, "description": "Update Scope\n\n**Operation ID:** update-scope", "body": { "mode": "raw", "raw": "{\n \"id\": \"f7cc82f5-cd53-43b7-986a-3de2fa327965\",\n \"name\": \"Updated Scope\",\n \"owner\": \"23b806db-bad2-4f7a-b8d1-ac117790999b\",\n \"description\": \"Scope description\",\n \"status\": \"archived\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Scope Tree", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/scopes/tree", "host": [ "{{base_url}}" ], "path": [ "scopes", "tree" ], "query": [], "variable": [] }, "description": "Get Scope Tree\n\n**Operation ID:** get-scope-tree", "body": { "mode": "raw", "raw": "{\n \"onlyActive\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Assign scopes", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/scopes/assign", "host": [ "{{base_url}}" ], "path": [ "scopes", "assign" ], "query": [], "variable": [] }, "description": "Assign hierarchical scopes to a supported system object.\n\n**Operation ID:** assign-scopes", "body": { "mode": "raw", "raw": "[\n {\n \"objectType\": \"control\",\n \"objectId\": \"6c006c16-9349-4df2-80be-64895c27d7bb\",\n \"scopeIds\": [\n \"2128c0da-140e-460d-974c-8cd20401afbc\",\n \"ef11b12c-3b75-4a19-b212-72dcbe010fe7\"\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Unassign scopes", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/scopes/unassign", "host": [ "{{base_url}}" ], "path": [ "scopes", "unassign" ], "query": [], "variable": [] }, "description": "Unassign hierarchical scopes from a supported system object.\n\n**Operation ID:** unassign-scopes", "body": { "mode": "raw", "raw": "[\n {\n \"objectType\": \"control\",\n \"objectId\": \"6c006c16-9349-4df2-80be-64895c27d7bb\",\n \"scopeIds\": [\n \"2128c0da-140e-460d-974c-8cd20401afbc\",\n \"ef11b12c-3b75-4a19-b212-72dcbe010fe7\"\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Scopes" }, { "name": "Tasks", "item": [ { "name": "Add Task", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/tasks/", "host": [ "{{base_url}}" ], "path": [ "tasks" ], "query": [], "variable": [] }, "description": "Add Task\n\n**Operation ID:** add-task", "body": { "mode": "raw", "raw": "{\n \"title\": \"Submit the latest employee agreements\",\n \"targetObject\": {\n \"objectId\": \"23b802db-bad2-4f7a-b8d1-ac1177909992\",\n \"objectType\": \"control\"\n },\n \"description\": \"The latest employee agreements are needed for the upcoming audit.\",\n \"assigneeId\": \"ad21d858-c271-4c6d-8780-fecf6b16e534\",\n \"priority\": \"medium\",\n \"dueDate\": \"2020-12-17T20:00:00Z\",\n \"hasIntegration\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Tasks Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/tasks/filter", "host": [ "{{base_url}}" ], "path": [ "tasks", "filter" ], "query": [], "variable": [] }, "description": "Get Tasks Filtered\n\n**Operation ID:** get-tasks-filtered", "body": { "mode": "raw", "raw": "{\n \"targetObjectType\": \"control\",\n \"targetObjectIds\": [\n \"23b802db-bad2-4f7a-b8d1-ac1177909992\"\n ],\n \"taskIds\": [\n \"23b802db-bad2-4f7a-b8d1-ac1177909992\"\n ],\n \"assigneeIds\": [\n \"23b802db-bad2-4f7a-b8d1-ac1177909992\"\n ],\n \"modifiedAfter\": \"2020-12-17T20:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Task", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Get Task\n\n**Operation ID:** get-task" }, "response": [] }, { "name": "Update Task", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Update Task\n\n**Operation ID:** update-task", "body": { "mode": "raw", "raw": "{\n \"title\": \"Submit the latest employee agreements\",\n \"description\": \"The latest employee agreements are needed for the upcoming audit.\",\n \"assigneeId\": \"ad21d858-c271-4c6d-8780-fecf6b16e534\",\n \"targetId\": \"23b802db-bad2-4f7a-b8d1-ac1177909992\",\n \"targetType\": \"control\",\n \"taskStatusId\": \"e2303b2b-5ee4-4354-92de-dfacd1d33f09\",\n \"priority\": \"medium\",\n \"dueDate\": \"2020-12-17T20:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Task Proof Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/proof", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "proof" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Get Task Proof Metadata\n\n**Operation ID:** get-task-proof-metadata" }, "response": [] }, { "name": "Add Task Proof", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/proof", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "proof" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Add Task Proof\n\n**Operation ID:** add-task-proof", "body": { "mode": "formdata", "formdata": [] } }, "response": [] }, { "name": "Get Task Comments", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/comments", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "comments" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Get Task Comments\n\n**Operation ID:** get-task-comments" }, "response": [] }, { "name": "Add Task Comment", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/comments", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "comments" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Add Task Comment\n\n**Operation ID:** add-task-comment", "body": { "mode": "raw", "raw": "{\n \"commentTextFormatted\": \"The audit is completed.\",\n \"isInternalComment\": true,\n \"objectId\": \"82d7c228-8bcd-11e9-a94b-ab3de849498z\",\n \"objectType\": \"risk\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Task Comment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/comments", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "comments" ], "query": [ { "key": "sourceCommentId", "value": "", "description": "Unique ID of the source comment.", "disabled": true } ], "variable": [ { "key": "taskId", "value": "", "description": "" } ] }, "description": "Update Task Comment\n\n**Operation ID:** update-task-comment-by-source-id", "body": { "mode": "raw", "raw": "{\n \"commentTextFormatted\": \"The audit is completed.\",\n \"isInternalComment\": true,\n \"objectId\": \"82d7c228-8bcd-11e9-a94b-ab3de849498z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Task Comment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/comments/:commentId", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "comments", ":commentId" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" }, { "key": "commentId", "value": "", "description": "" } ] }, "description": "Update Task Comment\n\n**Operation ID:** update-task-comment", "body": { "mode": "raw", "raw": "{\n \"commentTextFormatted\": \"The audit is completed.\",\n \"isInternalComment\": true,\n \"objectId\": \"82d7c228-8bcd-11e9-a94b-ab3de849498z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Task Comment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/tasks/:taskId/comments/:commentId", "host": [ "{{base_url}}" ], "path": [ "tasks", ":taskId", "comments", ":commentId" ], "query": [], "variable": [ { "key": "taskId", "value": "", "description": "" }, { "key": "commentId", "value": "", "description": "" } ] }, "description": "Delete Task Comment\n\n**Operation ID:** delete-task-comment" }, "response": [] } ], "description": "Endpoints for Tasks" }, { "name": "Task Statuses", "item": [ { "name": "Get Task Statuses", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/taskstatuses/", "host": [ "{{base_url}}" ], "path": [ "taskstatuses" ], "query": [], "variable": [] }, "description": "Get Task Statuses\n\n**Operation ID:** get-task-statuses" }, "response": [] } ], "description": "Endpoints for Task Statuses" }, { "name": "Test Results", "item": [ { "name": "Get Most Recent Test Results", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/testresults/mostrecent", "host": [ "{{base_url}}" ], "path": [ "testresults", "mostrecent" ], "query": [ { "key": "outcome", "value": "", "description": "Filters results by the provided test outcome", "disabled": true }, { "key": "testParentObjectType", "value": "", "description": "Filters by object type that the test whose results are being returned is created on.", "disabled": true }, { "key": "limit", "value": "", "description": "The maximum number of test results to return per page.", "disabled": true }, { "key": "nextToken", "value": "", "description": "Token returned from a previous call to retrieve test results.", "disabled": true } ], "variable": [] }, "description": "Get Most Recent Test Results\n\n**Operation ID:** get-most-recent-test-results" }, "response": [] } ], "description": "Endpoints for Test Results" }, { "name": "Users", "item": [ { "name": "Get User", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/users/me", "host": [ "{{base_url}}" ], "path": [ "users", "me" ], "query": [ { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: identityProviders, organizations.", "disabled": true } ], "variable": [] }, "description": "Get User\n\n**Operation ID:** get-user" }, "response": [] }, { "name": "Get Users", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/users/", "host": [ "{{base_url}}" ], "path": [ "users" ], "query": [ { "key": "expand", "value": "", "description": "Comma separated list of fields to expand. Supported values: identityProviders, organizationRoleId.", "disabled": true }, { "key": "includeDeactivated", "value": "", "description": "Whether or not to include deactivated users in the response.", "disabled": true } ], "variable": [] }, "description": "Get Users\n\n**Operation ID:** get-users" }, "response": [] } ], "description": "Endpoints for Users" }, { "name": "Vendors", "item": [ { "name": "Get Vendors", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/vendors/", "host": [ "{{base_url}}" ], "path": [ "vendors" ], "query": [ { "key": "status", "value": "", "description": "Filters vendors by the provided object status.", "disabled": true } ], "variable": [] }, "description": "Get Vendors\n\n**Operation ID:** get-vendors" }, "response": [] }, { "name": "Add Vendor", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/vendors/", "host": [ "{{base_url}}" ], "path": [ "vendors" ], "query": [], "variable": [] }, "description": "Add Vendor\n\n**Operation ID:** add-vendor", "body": { "mode": "raw", "raw": "{\n \"name\": \"Test Vendor from API\",\n \"category\": \"API\",\n \"ownerId\": \"e99e616e-6211-22ff-b755-633587729bf9\",\n \"vendorStatus\": \"approved\",\n \"tolerance\": \"high\",\n \"contractStartDate\": \"2024-09-04T12:00:00Z\",\n \"contractEndDate\": \"2025-09-04T12:00:00Z\",\n \"contacts\": [\n {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@example.com\"\n }\n ],\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Vendors", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/vendors/", "host": [ "{{base_url}}" ], "path": [ "vendors" ], "query": [], "variable": [] }, "description": "Update Vendors\n\n**Operation ID:** update-vendors", "body": { "mode": "raw", "raw": "{\n \"vendorIds\": [\n \"23b806db-bad2-4f7a-b8d1-ac1177909992\",\n \"23b402db-bad2-4f7a-b8d1-ac1177909992\"\n ],\n \"patch\": {\n \"category\": \"Updated Category\",\n \"vendorStatus\": \"rejected\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Vendors Filtered", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/vendors/filter", "host": [ "{{base_url}}" ], "path": [ "vendors", "filter" ], "query": [], "variable": [] }, "description": "Get Vendors Filtered\n\n**Operation ID:** get-vendors-filtered", "body": { "mode": "raw", "raw": "{\n \"vendorIds\": [\n \"23b806db-bad2-4f7a-b8d1-ac1177909992\",\n \"23b402db-bad2-4f7a-b8d1-ac1177909992\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Vendor", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/vendors/:vendorId", "host": [ "{{base_url}}" ], "path": [ "vendors", ":vendorId" ], "query": [], "variable": [ { "key": "vendorId", "value": "", "description": "" } ] }, "description": "Get Vendor\n\n**Operation ID:** get-vendor" }, "response": [] }, { "name": "Update Vendor", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/vendors/:vendorId", "host": [ "{{base_url}}" ], "path": [ "vendors", ":vendorId" ], "query": [], "variable": [ { "key": "vendorId", "value": "", "description": "" } ] }, "description": "Update Vendor\n\n**Operation ID:** update-vendor", "body": { "mode": "raw", "raw": "{\n \"name\": \"Test Vendor from API Update\",\n \"category\": \"API Category 2\",\n \"ownerId\": \"e99e616e-6211-22ff-b755-633587729bf9\",\n \"vendorStatus\": \"approved\",\n \"tolerance\": \"high\",\n \"riskLevel\": \"moderate\",\n \"riskLevelIsOverridden\": true,\n \"riskLevelOverrideReasoning\": \"Business decision to accept higher risk\",\n \"contractStartDate\": \"2024-09-04T12:00:00Z\",\n \"contractEndDate\": \"2025-09-04T12:00:00Z\",\n \"freshnessPolicy\": \"manual\",\n \"freshForDuration\": \"PT720H\",\n \"freshness\": \"fresh\",\n \"freshAsOfDate\": \"2025-01-12T18:26:10.00.5365Z\",\n \"freshAsOfNote\": \"Updating expired vendor freshness\",\n \"status\": \"active\",\n \"customFields\": [\n {\n \"fieldId\": \"ceb912ab-519b-11ee-a644-522476618ae8\",\n \"textValue\": \"Antonio Moreno\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Endpoints for Vendors" }, { "name": "Well-known", "item": [ { "name": "OAuth Authorization Server Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/.well-known/oauth-authorization-server", "host": [ "{{base_url}}" ], "path": [ ".well-known", "oauth-authorization-server" ], "query": [], "variable": [] }, "description": "Returns OAuth 2.0 authorization server metadata for client discovery (RFC 8414). No authentication required.\n\n**Operation ID:** get-oauth-authorization-server-metadata" }, "response": [] } ], "description": "Endpoints for Well-known" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.hyperproof.app/v1" }, { "key": "access_token", "value": "" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" } ] }