Skip to content
Governance Platform

List controls for a policy

GET
/api/v1/organizations/{orgId}/policies/{policyId}/controls
 
curl --request GET \
  --url https://localhost:10001/api/v1/organizations/example/policies/example/controls \
  --header 'Authorization: <Authorization>'

List all controls under a specific policy

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgId
required
string

Organization ID or UUID (urn:uuid optional)

policyId
required
string

Policy ID, slug:my-policy@1.2.0, or urn:cid:bafy…

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Controls

Media type application/json
Array<object>

A single requirement within a policy template, identified by its control code

object
cid

Assigned by the integrity service at creation

string
citations
Array<object>
object
title
string
url
string
controlCode

Alphanumeric, . and -; upper-cased

string
createdAt
string format: date-time
description
string
id
integer
policyId

Assigned from the parent policy

integer
title
string
updatedAt
string format: date-time
Example generated
[
  {
    "citations": [
      {
        "title": "example",
        "url": "example"
      }
    ],
    "controlCode": "example",
    "description": "example",
    "title": "example"
  }
]

400

Section titled “400 ”

Bad request - Invalid organization ID or policy ID

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

403

Section titled “403 ”

Forbidden - No organization access

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

404

Section titled “404 ”

Policy not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

500

Section titled “500 ”

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}