List Governance Programs
List every version of an organization's Governance Programs, with their controls
https://localhost:10001/api/v1/organizations/{orgId}/programscurl --request GET \
--url 'https://localhost:10001/api/v1/organizations/{orgId}/programs' \
--header 'Authorization: Bearer <token>'const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/programs", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
const data = await response.json();interface Program {
certification?: Record<string, unknown>;
controls?: Record<string, unknown>[];
createdAt?: string;
createdBy?: string;
createdByDid?: string;
createdByUserId?: string;
description?: string;
manifestCid?: string;
name?: string;
organizationId?: number;
organizationUuid?: string;
scope?: Record<string, unknown>;
slug?: string;
uuid?: string;
version?: string;
}
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/programs", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: Program[] = await response.json();import requests
response = requests.get(
"https://localhost:10001/api/v1/organizations/{orgId}/programs",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v1/organizations/{orgId}/programs", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:10001/api/v1/organizations/{orgId}/programs"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v1/organizations/{orgId}/programs");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/programs');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/programs")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://localhost:10001/api/v1/organizations/{orgId}/programs")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
orgIdrequired | string | Organization ID or UUID (urn:uuid optional) |
Responses
200Programs
Array of core.Program
certificationcore.ProgramCertificationThe rule an assessment must meet to certify under this program, and how long the certification lasts
Show core.ProgramCertification
ruleobjectread-onlyOne of
all_controls_satisfiedShow properties
object (enum)· one of all_controls_satisfiedvalidForstringISO 8601 duration in years, months, weeks, or days; absent when the program sets no expiry
controlscore.ProgramControl[]Show properties
Array of
core.ProgramControlappliesWhenobjectAbsent when the control applies to every agent
Show properties
anycore.ApplicabilityCondition[]At least one, each field once; stored and frozen sorted by field
Show properties
Array of
core.ApplicabilityConditionfieldobjectOne of
context.modecontext.actsForcontext.userssystems.accesssystems.datasystems.operations.impactShow properties
object (enum)· one of context.mode, context.actsFor, context.users, systems.access, systems.data, systems.operations.impactinstring[]At least one, each once, each a value the field can hold; stored and frozen sorted
citationscore.Citation[]The standards or frameworks the control derives from, as a policy control cites them
Show properties
Array of
core.CitationtitlestringUp to 255 characters; trimmed
urlstringAn absolute http or https URL with a hostname, up to 2048 bytes; trimmed
controlCodestringAlphanumeric, . and -; upper-cased; unique within the program
createdAtstring<date-time>read-onlyexpectedEvidencestring[]What the owner is expected to declare, as guidance for them and the reviewer; nothing checks it
guidancestringjudgescore.ProgramJudgesShow core.ProgramJudges
configurationcore.ConfigurationField[]Each once, each one the scope requires; stored and frozen sorted
profilecore.ProfileSection[]Each once; stored and frozen sorted
notApplicablecore.NotApplicableRuleShow core.NotApplicableRule
conditionstringRequired when permitted, rejected otherwise
permittedboolean
requirementstringtitlestringuuidstringread-onlyurn:uuid form
createdAtstring<date-time>read-onlycreatedBystringread-onlycreatedByDidstringread-onlyVerifiable actor; createdBy is the label
createdByUserIdstringread-onlyThe creator's user ID; absent on versions created before it was recorded
descriptionstringmanifestCidstringread-onlyAssigned by the Integrity Service at creation
namestringorganizationIdintegerread-onlyTaken from the path on create
organizationUuidstringread-onlyurn:uuid form; the owner named in the manifest
scopecore.ProgramScopeThe agent configuration a certification under this program binds: the configuration schema, and the fields an assessed agent's snapshot must have captured
Show core.ProgramScope
configurationstringread-onlyThe schema the fields belong to; always AgentConfigurationV1 today
requiredCoveragecore.ConfigurationField[]At least one, each once; stored and frozen sorted
slugstringread-onlyDerived from name; shared by every version of the program
uuidstringread-onlyurn:uuid form
versionstringSemVer with no leading "v" or build metadata, e.g. 1.2.3
[
{
"certification": {
"validFor": "P1Y"
},
"controls": [
{
"appliesWhen": {
"any": [
{
"field": "context.mode",
"in": [
"personal"
]
}
]
},
"citations": [
{
"title": "string",
"url": "string"
}
],
"controlCode": "string",
"expectedEvidence": [
"string"
],
"guidance": "string",
"judges": {
"configuration": [
"app"
],
"profile": [
"purpose"
]
},
"notApplicable": {
"condition": "string",
"permitted": true
},
"requirement": "string",
"title": "string"
}
],
"description": "string",
"name": "string",
"scope": {
"requiredCoverage": [
"app"
]
},
"version": "string"
}
]400Bad request - Invalid organization ID
errorstring
{
"error": "Invalid request body"
}401Unauthorized - Authentication required
errorstring
{
"error": "Invalid request body"
}403Forbidden - No organization access
errorstring
{
"error": "Invalid request body"
}500Internal server error
errorstring
{
"error": "Invalid request body"
}