control.update scope.
External DocumentationTo learn more, visit the Hyperproof documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Cancellations | Json object of an array of cancellations. Example: |
| Control ID | The unique identifier of the control to update. Can be obtained by using the List Controls action. |
| Control Identifier | The identifier of the control. |
| Description | The description of the control. |
| Name | The name of the control. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Automation | The automation status of the control. |
| Clear Domain | Whether to clear the domain or not. |
| Compute Testing Status | Whether to compute the testing status. |
| Custom Fields | A json object that includes the custom fields. For more information about how to construct this json please visit Hyperproof’s documentation. |
| Domain ID | The unique identifier of the domain. |
| Domain Name | The domain name of the control. |
| External Object IDs | A list of external object IDs for the control. |
| Fresh As Of Date | The fresh as of date of the control. |
| Fresh As Of Note | The fresh as of note of the control. |
| Fresh For Duration | The fresh for duration of the control. |
| Freshness Policy | The freshness policy of the control. |
| Health | Describes the health of the control. |
| Implementation | The implementation status of the control. |
| Notes | Notes for the control. |
| Override Health | Whether to override the health of the control. |
| Override Health On | Override health on of the control. |
| Override Health Reason | The reason behind overriding the health of the control. |
| Owner | The unique identifier of the user who owns the control. |
| Reset Freshness Note | The reset freshness note. |
| Scope ID | The identifier of the scope. |
| Status | The status of the control. |
| Testing Deficiency | A list of the testing deficiencies of the control. |
| Testing Status | The testing status of the control. |
Example Output
{
"id": "d88d505d-5199-11ee-a644-522476618ae8",
"orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
"controlType": "scopeAssignment",
"controlIdentifier": "SOC2-P4.1.1_Legal",
"name": "Include in the privacy notice the use of collected personal information",
"scopeName": "Legal",
"description": "The privacy notice identifies the use of collected personal information.",
"notes": "",
"domainId": "d7cf0a26-5199-11ee-a644-522476618ae8",
"domainName": "Privacy",
"freshnessPolicy": "manual",
"freshForDuration": "PT720H",
"freshness": "fresh",
"implementation": "inProgress",
"testingStatus": "effective",
"testingDeficiency": [],
"computeTestingStatus": false,
"automation": "partial",
"health": "notAvailable",
"overrideHealth": false,
"owner": {
"id": "d2363cab-5199-11ee-a644-522476618ae8",
"type": "activeUser",
"userId": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
"email": "jane.doe@example.com",
"givenName": "Jane",
"surname": "Doe",
"language": "en",
"locale": "US",
"timeZone": "America/Los_Angeles",
"status": "active"
},
"customFields": [
{
"fieldId": "ceb912ab-519b-11ee-a644-522476618ae8",
"fieldName": "Sponsor",
"fieldType": "text",
"textValue": "John Smith"
}
],
"status": "active",
"createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
"createdOn": "2023-09-12T18:26:10.005365Z",
"updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
"updatedOn": "2023-09-12T18:26:10.005365Z",
"permissions": []
}