Skip to content
Hyperproof API
/
/
Scope Assignments API

Scope Assignments API (1.0)

Associates compatible objects with Hierarchical Scopes in Hyperproof.

Download OpenAPI description
scopeassignments.openapi.json
scopeassignments.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/scope-assignments/scopeassignments.openapi
Hyperproof US
https://api.hyperproof.app/v1/scopeassignments
Hyperproof Gov
https://api.hyperproofgov.app/v1/scopeassignments
Hyperproof EU
https://api.hyperproof.eu/v1/scopeassignments

Scope Assigments

Request

POST /

Description

Creates or updates hiearchical scope assignments in a Hyperproof organization.

Security
oauth2
Bodyapplication/jsonArray [
objectTypestring(ObjectType)

The type of the object.

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
objectIdstring

The unique identifier of the object which will be associated with one or more scopes

scopeIdsArray of strings

The unique identifiers of the scopes which will be associated with the object

]
curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/scope-assignments/scopeassignments.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "objectType": "control",
      "objectId": "6c006c16-9349-4df2-80be-64895c27d7bb",
      "scopeIds": [
        "2128c0da-140e-460d-974c-8cd20401afbc",
        "ef11b12c-3b75-4a19-b212-72dcbe010fe7"
      ]
    }
  ]'

Responses

Success.

Bodyapplication/json
controlsArray of objects(Control)
Example: [{"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","freshAsOfDate":"2025-01-12T18:26:10.00.5365Z","freshAsOfNote":"Initial freshness set","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":[]}]
Response
application/json
{
  "controls": [
    { … }
  ]
}
® 2026 Hyperproof All Rights Reserved.