Skip to content
Governance Platform
Search
Ctrl
K
Cancel
Version
v1.0.1
v0.2.0
Select theme
Dark
Light
Auto
v1.0.1
Get Started
Release Overview
Release Notes
Prerequisites
Connected Install
Air-Gapped Install
Use Governance Studio
Overview
Get Started
Key Concepts
Roles and Permissions
Member Management
Projects
Policies
Controls
Declarations and Reviews
Indicators
Credentials
Reports
Lineage Graphs
Activity Logs
API Keys
Integrity Actions
Glossary
APIs and Services
Governance Service
Governance Service Overview
Governance Service Architecture
Governance Service Authentication and RBAC
Projects, Policies, and Controls
Indicators and Events
Project-Scoped Indicators
Declarations, Attachments, and Credentials
Governance Service Configuration
Governance Service Operations
Evaluation Criteria Reference
API Reference
Overview
Activity Logs
Create activity log
POST
List activity logs by organization
GET
List activity logs by project
GET
Attachments
Download attachment
GET
Download attachment public URL
GET
Get attachment public URL
GET
Organizations
List all organizations
GET
Create organization
POST
Get organization by ID
GET
Get organization by Auth ID
GET
Policies
List all policies
GET
Create policy
POST
Get policy
GET
Convert policy Excel to JSON
POST
Export policy JSON to Excel
POST
Controls
List controls for a policy
GET
Get control
GET
Projects
List projects under an organization
GET
Create project
POST
Get project
GET
Set project archived state
PUT
Get project by UUID
GET
Project Policies
List project policies
GET
Apply policy to a project
POST
Get project policy by IDs
GET
Update project policy timestamp
PUT
Set project policy archived state
PUT
Get project policy control
GET
Get project policy credentials
GET
Create project policy credential
POST
Revoke project policy credential
PUT
Get project policy details
GET
List baseline project policies
GET
Get project policy manifest
POST
Generate project policy report
POST
Declarations
Create declaration on a control
POST
Create declaration with attachment
POST
Reviews
Create review
POST
Create review with attachment
POST
Evaluations v2
List evaluation results
GET
Get evaluation result
GET
Events v2
Ingest event for indicator evaluation
POST
Project Indicators v2
List enriched project indicator applications
GET
Get enriched project indicator application
GET
Remove project indicator application
DELETE
Disable project indicator application
POST
Activate project indicator application
POST
List project-scoped indicators
GET
Create project-scoped indicator
POST
Get project-scoped indicator
GET
Archive project-scoped indicator
DELETE
List project indicator applications
GET
Apply project indicator to controls
POST
Health
Liveness probe
GET
Authenticated health check for the auth integration
GET
Readiness probe
GET
Auth Service
Auth Service Overview
Identity Providers
Token Flows
RBAC and Membership
API Keys and Service Accounts
DID Key Management
Auth Service Configuration
Authentication and Authorization Guidelines
Auth Service Operations
Key Configuration
Membership Management
Refresh Tokens
Service Account Setup
Token Exchange
API Reference
Overview
API Keys
List API keys
GET
Create API key
POST
Get API key details
GET
Revoke API key
DELETE
Authentication
Get JSON Web Key Set for token validation
GET
Enrich JWT claims with user context and ensure DID key
POST
Exchange or refresh an access token
POST
Validate a credential and resolve the caller
POST
DID Keys
Create a DID key for a user
POST
Get DID key information
GET
Delete a DID key
DELETE
List user's DID keys
GET
Get current user's DID document
GET
Get platform DID document
GET
Sign a digest with the platform DID key
POST
Sign a digest with the authenticated user's DID key
POST
Sign a PDF digest with the platform DID key
POST
External Users
List external users from IDP
GET
Import an external IDP user into the platform
POST
Organizations
Add user to organization
POST
Remove user from organization
DELETE
Update organization member roles
PATCH
Memberships
Get user memberships within an organization
GET
List memberships for all users in an organization
GET
Update user roles in a project
PUT
Assign user to project
POST
Remove user from project
DELETE
Users
Get user profile
GET
List platform users
GET
RBAC
Check user permission
GET
Check user permission in project
GET
Get permission metadata
GET
Get role metadata
GET
Get user permissions for governance
GET
Get current user's roles
GET
Service Accounts
Get service account access token
GET
Service API
Get DID key for service
GET
List user's DID keys for service
GET
Health
Liveness probe
GET
Authenticated health check for IDP actions
GET
Readiness check endpoint
GET
Integrity Service
Integrity Service Overview
Evidence Records
Lineage Graphs
Policy Manifests and Certificates
Integrity Service Operations
Integrity Service Troubleshooting
API Reference
Overview
CID
Overview
Find CID
GET
Credentials
Overview
allocate
POST
revoke_vc
POST
status
GET
get_status_list
GET
Dynamic Config
Overview
Get the current dynamic configuration
GET
Update the dynamic configuration
PUT
Statements
Overview
Stores and Indexes the uploaded statement.
PUT
Stores and indexes the uploaded statements in batch.
PUT
create_did
PUT
Get statement by Statement ID
GET
Store
Overview
Put blob into store
PUT
Put base64-encoded blobs into store in a single request.
PUT
Get blob from store by CID
GET
Check if a CID exists in the blob store
GET
Get blob as iroh-collection json from store by CID
GET
Put JCS-serialized json document into store
PUT
Get blob as text from store by CID
GET
Utils
Overview
Compute ID for integrity statement
POST
Compute CID for canonicalized RDF of JSON-LD document
POST
Get static contexts used for JSON-LD expansion
GET
Convert JSON-LD document to NQuads document
POST
Manifest
Overview
get
GET
Register all statements and blobs from a manifest into a new graph.
POST
Governance
Overview
Cids the provided policy, and all the included controls. All items are stored in the blob store.
POST
Cids the provided Subject, and saves it in the blob store.
POST
Creates a governance statement for the declaration
POST
Creates a governance statement for the review
POST
issue_membership
POST
issue_certificate
POST
policy_manifest
POST
Graph
Overview
Get all graphs
GET
Register a new GraphID
PUT
Gets all the child graphs of the provided UUID
GET
Health
Overview
Get the health status of the service
GET
Deploy
Deployment Overview
Identity Providers
Storage and Key Management
Operate
Upgrade
Rollback
Observability
Backup and Restore
Troubleshooting
Known Issues
Reference
Helm Values
Release Manifest
v0.2.0
Get Started
Release Overview
Release Notes
Prerequisites
Connected Install
Air-Gapped Install
Use Governance Studio
Governance Studio Overview
Governance Studio First Steps
Projects
Policies and Controls
Declarations and Reviews
Indicators
Lineage and Certificates
Indicators Quickstart
Users, Roles, and API Keys
Evaluation Criteria Reference
Governance Studio Troubleshooting
JSONPath Quick Reference
APIs and Services
Governance Service
Governance Service Overview
Governance Service Architecture
Governance Service Authentication and RBAC
Projects, Policies, and Controls API
Indicators and Events
Project-Scoped Indicators
Declarations, Attachments, and Certificates
Governance Service Configuration
Governance Service Operations
Evaluation Criteria Reference
API Reference
Overview
Activity Logs
Create activity log
POST
List activity logs by organization
GET
List activity logs by project
GET
Attachments
Download attachment
GET
Download attachment public URL
GET
Get attachment public URL
GET
Organizations
List all organizations
GET
Create organization
POST
Get organization by ID
GET
Get organization by Auth ID
GET
Policies
List all policies
GET
Create policy
POST
Get policy
GET
Convert policy Excel to JSON
POST
Export policy JSON to Excel
POST
Controls
List controls for a policy
GET
Get control
GET
Projects
List projects under an organization
GET
Create project
POST
Get project
GET
Set project archived state
PUT
Credentials
List project credentials
GET
Create project credential
POST
Get project credential
GET
Update project credential
PUT
Delete project credential
DELETE
Validate credential
POST
Demo Data
Confirm and create demo data
POST
Preview demo data CSV upload
POST
Cancel preview session
DELETE
Project Policies
List project policies
GET
Apply policy to a project
POST
Get project policy by IDs
GET
Update project policy timestamp
PUT
Set project policy archived state
PUT
Get project policy certificates
GET
Create project policy certificate
POST
Revoke project policy certificate
PUT
Get project policy control
GET
Get project policy details
GET
List baseline project policies
GET
Get project policy manifest
POST
Generate project policy report
POST
Declarations
Create declaration on a control
POST
Create declaration with attachment
POST
Reviews
Create review
POST
Create review with attachment
POST
Evaluations v2
List evaluation results
GET
Get evaluation result
GET
Events v2
Ingest event for indicator evaluation
POST
Project Indicators v2
List enriched project indicator applications
GET
Get enriched project indicator application
GET
Remove project indicator application
DELETE
Disable project indicator application
POST
Activate project indicator application
POST
List project-scoped indicators
GET
Create project-scoped indicator
POST
Get project-scoped indicator
GET
Archive project-scoped indicator
DELETE
List project indicator applications
GET
Apply project indicator to controls
POST
Health
Liveness probe
GET
Authenticated health check for the auth integration
GET
Readiness check endpoint
GET
Auth Service
Auth Service Overview
Identity Providers
Token Flows
RBAC and Membership
API Keys and Service Accounts
DID Key Management
Auth Service Configuration
Authentication and Authorization Guidelines
Auth Service Operations
Key Configuration
Membership Management API
Refresh Tokens
Service Account Setup
Token Exchange
API Reference
Overview
API Keys
List API keys
GET
Create API key
POST
Get API key details
GET
Revoke API key
DELETE
Authentication
Get JSON Web Key Set for token validation
GET
Enrich JWT claims with user context and ensure DID key
POST
Exchange or refresh an access token
POST
Validate a credential and resolve the caller
POST
DID Keys
Create a DID key for a user
POST
Get DID key information
GET
Delete a DID key
DELETE
List user's DID keys
GET
Get current user's DID document
GET
Get platform DID document
GET
Sign a digest with the platform DID key
POST
Sign a digest with the authenticated user's DID key
POST
Sign a PDF digest with the platform DID key
POST
External Users
List external users from IDP
GET
Import an external IDP user into the platform
POST
Organizations
Add user to organization
POST
Remove user from organization
DELETE
Update organization member roles
PATCH
Memberships
Get user memberships within an organization
GET
List memberships for all users in an organization
GET
Update user roles in a project
PUT
Assign user to project
POST
Remove user from project
DELETE
Users
Get user profile
GET
List platform users
GET
RBAC
Check user permission
GET
Check user permission in project
GET
Get permission metadata
GET
Get role metadata
GET
Get user permissions for governance
GET
Get current user's roles
GET
Service Accounts
Get service account access token
GET
Service API
Get DID key for service
GET
List user's DID keys for service
GET
Health
Liveness probe
GET
Authenticated health check for IDP actions
GET
Readiness check endpoint
GET
Integrity Service
API Reference
Overview
CID
Overview
Find CID
GET
Credentials
Overview
allocate
POST
revoke_vc
POST
status
GET
get_status_list
GET
Dynamic Config
Overview
Get the current dynamic configuration
GET
Update the dynamic configuration
PUT
Statements
Overview
Stores and Indexes the uploaded statement.
PUT
Stores and indexes the uploaded statements in batch.
PUT
create_did
PUT
Get statement by Statement ID
GET
Store
Overview
Put blob into store
PUT
Put base64-encoded blobs into store in a single request.
PUT
Get blob from store by CID
GET
Check if a CID exists in the blob store
GET
Get blob as iroh-collection json from store by CID
GET
Put JCS-serialized json document into store
PUT
Get blob as text from store by CID
GET
Utils
Overview
Compute ID for integrity statement
POST
Compute CID for canonicalized RDF of JSON-LD document
POST
Get static contexts used for JSON-LD expansion
GET
Convert JSON-LD document to NQuads document
POST
Manifest
Overview
get
GET
Governance
Overview
Cids the provided policy, and all the included controls. All items are stored in the blob store.
POST
Cids the provided Subject, and saves it in the blob store.
POST
Creates a governance statement for the declaration
POST
Creates a governance statement for the review
POST
issue_certificate
POST
policy_manifest
POST
Graph
Overview
Get all graphs
GET
Register a new GraphID
PUT
Gets all the child graphs of the provided UUID
GET
Health
Overview
Get the health status of the service
GET
Deploy
Deployment Overview
Identity Providers
Storage and Key Management
Keycloak Recipe
Private Registry Recipe
Operate
Upgrade
Rollback
Observability
Backup and Restore
Troubleshooting
Known Issues
Reference
Helm Values
Release Manifest
Version
v1.0.1
v0.2.0
Select theme
Dark
Light
Auto
Overview
Integrity Service
2.1.0
Section titled “Integrity Service 2.1.0”
Information
OpenAPI version:
3.0.3
Operations
Section titled “ Operations ”
GET
/cid/v1/find/{cid}
POST
/credentials/v1/allocate
POST
/credentials/v1/revoke/{credentialId}
GET
/credentials/v1/status
GET
/credentials/v1/status-lists/{id}
GET
/dynamic-config/v1
PUT
/dynamic-config/v1
PUT
/statements/v1
PUT
/statements/v1/batch
PUT
/statements/v1/create/did/{did_key}
GET
/statements/v1/id/{id}
PUT
/store/v1/blob
PUT
/store/v1/blob/batch
GET
/store/v1/blob/{cid}
GET
/store/v1/exists/{cid}
GET
/store/v1/iroh-collection/{cid}
PUT
/store/v1/jcs
GET
/store/v1/text/{cid}
POST
/utils/v1/integrity/statement/compute-id
POST
/utils/v1/json-ld/rdfc_cid
GET
/utils/v1/json-ld/static-contexts
POST
/utils/v1/json-ld/to-nquads
GET
/manifest/v1
POST
/manifest/v1
POST
/gov/v1/cid/policy
POST
/gov/v1/cid/subject
POST
/gov/v1/controls/declaration/{subject_cid}/{project_uuid}
POST
/gov/v1/controls/review/{subject_cid}/{project_uuid}
POST
/gov/v1/identity/membership/{project_uuid}
POST
/gov/v1/policy/compliance/{project_uuid}
POST
/gov/v1/policy/manifest/{project_uuid}
GET
/graph/v1
PUT
/graph/v1
GET
/graph/v1/{uuid}
GET
/health/v1
Authentication
Section titled “ Authentication ”
Bearer
Section titled “Bearer ”
Security scheme type:
http
Bearer format:
JWT