EQTY LabDocs

Get Governance Program

Retrieve one Governance Program version with its controls

gethttps://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}
bash
curl --request GET \
  --url 'https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
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/{programId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: Program = await response.json();
python
import requests

response = requests.get(
    "https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}", 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))
}
java
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/{programId}"))
            .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());
    }
}
csharp
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/{programId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}');
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;
ruby
require "net/http"

uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/programs/{programId}")
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}"
rust
// 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/{programId}")
        .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

NameTypeDescription
orgId
required
string

Organization ID or UUID (urn:uuid optional)

programId
required
string

Program UUID (urn:uuid optional), slug:agent-baseline@1.0.0, or urn:cid:<manifest cid>

Responses

200Program with controls

application/json
  • certificationcore.ProgramCertification

    The rule an assessment must meet to certify under this program, and how long the certification lasts

    Show core.ProgramCertification
    • ruleobjectread-only

      One ofall_controls_satisfied

      Show properties

      object (enum) · one of all_controls_satisfied

    • validForstring

      ISO 8601 duration in years, months, weeks, or days; absent when the program sets no expiry

  • controlscore.ProgramControl[]
    Show properties

    Array of core.ProgramControl

    • appliesWhenobject

      Absent 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.ApplicabilityCondition

        • fieldobject

          One ofcontext.modecontext.actsForcontext.userssystems.accesssystems.datasystems.operations.impact

          Show properties

          object (enum) · one of context.mode, context.actsFor, context.users, systems.access, systems.data, systems.operations.impact

        • instring[]

          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.Citation

      • titlestring

        Up to 255 characters; trimmed

      • urlstring

        An absolute http or https URL with a hostname, up to 2048 bytes; trimmed

    • controlCodestring

      Alphanumeric, . and -; upper-cased; unique within the program

    • createdAtstring<date-time>read-only
    • expectedEvidencestring[]

      What the owner is expected to declare, as guidance for them and the reviewer; nothing checks it

    • guidancestring
    • judgescore.ProgramJudges
      Show core.ProgramJudges
      • configurationcore.ConfigurationField[]

        Each once, each one the scope requires; stored and frozen sorted

      • profilecore.ProfileSection[]

        Each once; stored and frozen sorted

    • notApplicablecore.NotApplicableRule
      Show core.NotApplicableRule
      • conditionstring

        Required when permitted, rejected otherwise

      • permittedboolean
    • requirementstring
    • titlestring
    • uuidstringread-only

      urn:uuid form

  • createdAtstring<date-time>read-only
  • createdBystringread-only
  • createdByDidstringread-only

    Verifiable actor; createdBy is the label

  • createdByUserIdstringread-only

    The creator's user ID; absent on versions created before it was recorded

  • descriptionstring
  • manifestCidstringread-only

    Assigned by the Integrity Service at creation

  • namestring
  • organizationIdintegerread-only

    Taken from the path on create

  • organizationUuidstringread-only

    urn:uuid form; the owner named in the manifest

  • scopecore.ProgramScope

    The 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-only

      The schema the fields belong to; always AgentConfigurationV1 today

    • requiredCoveragecore.ConfigurationField[]

      At least one, each once; stored and frozen sorted

  • slugstringread-only

    Derived from name; shared by every version of the program

  • uuidstringread-only

    urn:uuid form

  • versionstring

    SemVer with no leading "v" or build metadata, e.g. 1.2.3

Examplejson
{
  "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"
    }
  ],
  "createdAt": "2025-01-01T00:00:00Z",
  "createdBy": "string",
  "createdByDid": "string",
  "createdByUserId": "string",
  "description": "string",
  "manifestCid": "string",
  "name": "string",
  "organizationId": 0,
  "organizationUuid": "string",
  "scope": {
    "requiredCoverage": [
      "app"
    ]
  },
  "slug": "string",
  "uuid": "string",
  "version": "string"
}

400Bad request - Invalid organization ID or program ID

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

403Forbidden - No organization access

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

404Program not found

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

500Internal server error

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}