Governance Service API

REST API for managing organizations, projects, policies, controls, indicators, evidence attachments, and compliance workflows within Guardian.

Version: 1.2.1
Base URL: https://localhost:10001

Authentication

ApiKeyAuth · API key in header "Authorization" — Type "Bearer" followed by a space and API key.
BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Activity Logs

postCreate activity log/api/v1/activity-logs
getList activity logs by organization/api/v1/organizations/{orgId}/activity-logs
getList activity logs by organization member/api/v1/organizations/{orgId}/members/{userId}/activity-logs
getList activity logs by project/api/v1/projects/{projectId}/activity-logs

Attachments

getDownload attachment/api/v1/attachments/{attachmentId}
getDownload attachment public URL/api/v1/attachments/{attachmentId}/download
getGet attachment public URL/api/v1/attachments/{attachmentId}/url

Organizations

getList organizations/api/v1/organizations
postCreate organization/api/v1/organizations
getGet organization by ID/api/v1/organizations/{orgId}
getGet organization by Auth ID/api/v1/organizations/active/{authId}

Assessments

getList agent assessments/api/v1/organizations/{orgId}/assessments
postCreate agent assessment/api/v1/organizations/{orgId}/assessments
getGet agent assessment/api/v1/organizations/{orgId}/assessments/{assessmentId}
getList an assessment's certifications/api/v1/organizations/{orgId}/assessments/{assessmentId}/certifications
postCertify an agent assessment/api/v1/organizations/{orgId}/assessments/{assessmentId}/certifications
putRevoke an agent certification/api/v1/organizations/{orgId}/assessments/{assessmentId}/certifications/{credentialId}/revoke
putPin an assessment's configuration/api/v1/organizations/{orgId}/assessments/{assessmentId}/configuration
getCompare an assessment's configuration with the agent's current one/api/v1/organizations/{orgId}/assessments/{assessmentId}/configuration-status
putClaim an assessment control not applicable/api/v1/organizations/{orgId}/assessments/{assessmentId}/controls/{controlCode}/not-applicable
deleteWithdraw a not-applicable claim/api/v1/organizations/{orgId}/assessments/{assessmentId}/controls/{controlCode}/not-applicable
postDeclare how an agent meets assessment controls/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations
deleteRemove a declaration from an assessment's draft/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}
getDownload an assessment declaration's file/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download
getGet a URL for an assessment declaration's file/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/url
postDeclare with files how an agent meets assessment controls/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/with-file
getGet an assessment's draft/api/v1/organizations/{orgId}/assessments/{assessmentId}/draft
putPin an assessment's operating profile/api/v1/organizations/{orgId}/assessments/{assessmentId}/profile
deleteUnpin an assessment's operating profile/api/v1/organizations/{orgId}/assessments/{assessmentId}/profile
getList an assessment's submissions/api/v1/organizations/{orgId}/assessments/{assessmentId}/submissions
postSubmit an assessment for review/api/v1/organizations/{orgId}/assessments/{assessmentId}/submissions
getGet an assessment submission/api/v1/organizations/{orgId}/assessments/{assessmentId}/submissions/{submission}
postReview a control of an assessment submission/api/v1/organizations/{orgId}/assessments/{assessmentId}/submissions/{submission}/controls/{controlCode}/reviews
getRead a file an assessment submission froze/api/v1/organizations/{orgId}/assessments/{assessmentId}/submissions/{submission}/files/{cid}
getList agent certifications/api/v1/organizations/{orgId}/certifications

Policies

getList all policies/api/v1/organizations/{orgId}/policies
postCreate policy/api/v1/organizations/{orgId}/policies
getGet policy/api/v1/organizations/{orgId}/policies/{policyId}
postConvert policy Excel to JSON/api/v1/policies/convert
postExport policy JSON to Excel/api/v1/policies/export

Controls

getList controls for a policy/api/v1/organizations/{orgId}/policies/{policyId}/controls
getGet control/api/v1/organizations/{orgId}/policies/{policyId}/controls/{controlId}

Programs

getList Governance Programs/api/v1/organizations/{orgId}/programs
postCreate Governance Program/api/v1/organizations/{orgId}/programs
getGet Governance Program/api/v1/organizations/{orgId}/programs/{programId}
getList a program's reviewers/api/v1/organizations/{orgId}/programs/{programId}/reviewers
postAssign a program reviewer/api/v1/organizations/{orgId}/programs/{programId}/reviewers
deleteRemove a program reviewer/api/v1/organizations/{orgId}/programs/{programId}/reviewers/{userId}

Projects

getList projects under an organization/api/v1/organizations/{orgId}/projects
postCreate project/api/v1/organizations/{orgId}/projects
getGet project/api/v1/organizations/{orgId}/projects/{projectId}
putSet project archived state/api/v1/organizations/{orgId}/projects/{projectId}/archived
getGet project by UUID/api/v1/projects/by-uuid/{projectUUID}

Applied Policies

getList applied policies/api/v1/projects/{projectId}/policies
getGet applied policy by IDs/api/v1/projects/{projectId}/policies/{appliedPolicyId}
putUpdate applied policy timestamp/api/v1/projects/{projectId}/policies/{appliedPolicyId}
putSet applied policy archived state/api/v1/projects/{projectId}/policies/{appliedPolicyId}/archived
getGet applied policy control/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}
getGet applied policy credentials/api/v1/projects/{projectId}/policies/{appliedPolicyId}/credentials
postCreate applied policy credential/api/v1/projects/{projectId}/policies/{appliedPolicyId}/credentials
putRevoke applied policy credential/api/v1/projects/{projectId}/policies/{appliedPolicyId}/credentials/{credentialId}/revoke
getGet applied policy details/api/v1/projects/{projectId}/policies/{appliedPolicyId}/details
postApply policy to a project/api/v1/projects/{projectId}/policies/{policyId}
getList baseline applied policies/api/v1/projects/{projectId}/policies/baseline
postGet applied policy manifest/api/v1/projects/{projectId}/policies/manifest
postGenerate applied policy report/api/v1/projects/{projectId}/policies/report

Declarations

postCreate declaration on a control/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/declarations
postCreate declaration with attachment/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/declarations/with-file

Reviews

postCreate review/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews
postCreate review with attachment/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file

Evaluations v2

getList evaluation results/api/v2/evaluations
getGet evaluation result/api/v2/evaluations/{id}

Events v2

postIngest event for indicator evaluation/api/v2/events/ingest

Project Indicators v2

getList enriched project indicator applications/api/v2/projects/{projectId}/indicator-applications
postApply project indicators to controls/api/v2/projects/{projectId}/indicator-applications
getGet enriched project indicator application/api/v2/projects/{projectId}/indicator-applications/{applicationId}
deleteRemove project indicator application/api/v2/projects/{projectId}/indicator-applications/{applicationId}
postDisable project indicator application/api/v2/projects/{projectId}/indicator-applications/{applicationId}/disable
postActivate project indicator application/api/v2/projects/{projectId}/indicator-applications/{applicationId}/enable
getList project-scoped indicators/api/v2/projects/{projectId}/indicators
postCreate project-scoped indicator/api/v2/projects/{projectId}/indicators
getGet project-scoped indicator/api/v2/projects/{projectId}/indicators/{indicatorId}
deleteArchive project-scoped indicator/api/v2/projects/{projectId}/indicators/{indicatorId}
getList project indicator applications/api/v2/projects/{projectId}/indicators/{indicatorId}/applications

Health

getLiveness probe/health
getAuthenticated health check for the auth integration/health/auth
getReadiness probe/health/ready