Shared schemas
Generated schema definitions referenced by operation pages.
{
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"issues": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"error"
]
},
"AgentConfigurationInput": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"pollSeconds": {
"type": "integer",
"minimum": 5,
"maximum": 120
},
"allowedTargets": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "^[A-Za-z0-9.[\\]:-]+$"
}
},
"allowedSshTargets": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "^[A-Za-z0-9.[\\]:-]+$"
}
},
"repositoryRoots": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"captureRoots": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
}
},
"required": [
"enabled",
"pollSeconds",
"allowedTargets",
"allowedSshTargets",
"repositoryRoots"
],
"additionalProperties": false
}
},
"required": [
"expectedRevision",
"settings"
],
"additionalProperties": false
},
"AgentConfigurationStatus": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"applied",
"rejected"
]
},
"reason": {
"type": "string",
"enum": [
"none",
"local-opt-in-required",
"outside-local-scope",
"invalid-configuration"
]
}
},
"required": [
"revision",
"status",
"reason"
],
"additionalProperties": false
},
"ManagedSettings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"pollSeconds": {
"type": "integer",
"minimum": 5,
"maximum": 120
},
"allowedTargets": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "^[A-Za-z0-9.[\\]:-]+$"
}
},
"allowedSshTargets": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "^[A-Za-z0-9.[\\]:-]+$"
}
},
"repositoryRoots": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"captureRoots": {
"maxItems": 256,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
}
},
"required": [
"enabled",
"pollSeconds",
"allowedTargets",
"allowedSshTargets",
"repositoryRoots"
],
"additionalProperties": false
},
"PlanInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"assetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"owner": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"dueDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"status": {
"default": "planned",
"type": "string",
"const": "planned"
},
"criteria": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"keyEstablishment": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"authentication": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"minimumConfidence": {
"default": 0.9,
"type": "number",
"minimum": 0.8,
"maximum": 1
}
},
"additionalProperties": false
}
},
"required": [
"title",
"assetId",
"owner",
"dueDate"
],
"additionalProperties": false
},
"PlanUpdate": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"owner": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"dueDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"criteria": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"keyEstablishment": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"authentication": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"minimumConfidence": {
"default": 0.9,
"type": "number",
"minimum": 0.8,
"maximum": 1
}
},
"additionalProperties": false
}
},
"required": [
"expectedVersion"
],
"additionalProperties": false
},
"PlanState": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"planned",
"in-progress",
"verified"
]
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"evidenceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"expectedVersion",
"status",
"reason"
],
"additionalProperties": false
},
"Observation": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kind": {
"type": "string",
"enum": [
"tls",
"ssh",
"code",
"certificate",
"library",
"key",
"cloud",
"runtime"
]
},
"algorithm": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"keyEstablishment": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"authentication": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"observedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"exposure": {
"default": "internal",
"type": "string",
"enum": [
"public",
"partner",
"internal",
"isolated"
]
},
"criticality": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"retentionYears": {
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"migrationFriction": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"dependencyCount": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"dependencies": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"deadline": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"location": {
"type": "string",
"maxLength": 1000
},
"owner": {
"default": "Unassigned",
"type": "string",
"maxLength": 200
},
"evidence": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"externalId",
"name",
"kind",
"source",
"observedAt",
"confidence"
],
"additionalProperties": false
},
"ObservationBatch": {
"type": "object",
"properties": {
"observations": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kind": {
"type": "string",
"enum": [
"tls",
"ssh",
"code",
"certificate",
"library",
"key",
"cloud",
"runtime"
]
},
"algorithm": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"keyEstablishment": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"authentication": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"observedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"exposure": {
"default": "internal",
"type": "string",
"enum": [
"public",
"partner",
"internal",
"isolated"
]
},
"criticality": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"retentionYears": {
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"migrationFriction": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"dependencyCount": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"dependencies": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"deadline": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"location": {
"type": "string",
"maxLength": 1000
},
"owner": {
"default": "Unassigned",
"type": "string",
"maxLength": 200
},
"evidence": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"externalId",
"name",
"kind",
"source",
"observedAt",
"confidence"
],
"additionalProperties": false
}
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 100
},
"jobId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"leaseToken": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"observations",
"idempotencyKey"
],
"additionalProperties": false,
"dependentRequired": {
"jobId": [
"leaseToken"
],
"leaseToken": [
"jobId"
]
}
},
"JobInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kind": {
"type": "string",
"enum": [
"tls",
"code",
"ssh",
"capture"
]
},
"target": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"agentId": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"required": [
"name",
"kind",
"target",
"agentId"
],
"additionalProperties": false
},
"ScheduleInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kind": {
"type": "string",
"enum": [
"tls",
"code",
"ssh",
"capture"
]
},
"target": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"agentId": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"intervalSeconds": {
"type": "integer",
"minimum": 300,
"maximum": 2592000
},
"firstRunAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"name",
"kind",
"target",
"agentId",
"intervalSeconds"
],
"additionalProperties": false
},
"Organization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"name",
"createdAt"
]
},
"Credential": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"role": {
"enum": [
"admin",
"analyst",
"viewer",
"agent",
"ingestor"
]
},
"agentId": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"revoked": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"role",
"createdAt",
"expiresAt"
]
},
"IssuedCredential": {
"allOf": [
{
"$ref": "#/components/schemas/Credential"
},
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
]
}
]
},
"Agent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"enum": [
"tls",
"code",
"ssh",
"capture"
]
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"lastSeen": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"credentialId": {
"type": "string",
"format": "uuid"
},
"revokedAt": {
"type": "string",
"format": "date-time"
},
"configuration": {
"type": [
"object",
"null"
],
"properties": {
"revision": {
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/ManagedSettings"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"updatedBy": {
"type": "string"
}
}
},
"configurationStatus": {
"type": [
"object",
"null"
],
"properties": {
"revision": {
"type": "integer"
},
"status": {
"enum": [
"applied",
"rejected"
]
},
"reason": {
"type": "string"
},
"reportedAt": {
"type": "string",
"format": "date-time"
}
}
},
"runtime": {
"type": "object",
"properties": {
"scannerVersion": {
"type": "string"
},
"pythonVersion": {
"type": "string"
},
"reportedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"reportedAt"
]
}
},
"required": [
"id",
"name",
"capabilities",
"createdAt",
"credentialId"
]
},
"Risk": {
"type": "object",
"properties": {
"policyVersion": {
"type": "string"
},
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"severity": {
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"keyEstablishment": {
"type": "string"
},
"authentication": {
"type": "string"
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"verificationPriority": {
"type": "integer"
},
"dimensions": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"action": {
"type": "string"
}
},
"required": [
"policyVersion",
"score",
"severity",
"keyEstablishment",
"authentication",
"confidence",
"dimensions"
]
},
"RiskRun": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"policyVersion": {
"type": "string"
},
"status": {
"enum": [
"pending",
"running",
"completed",
"paused",
"superseded"
]
},
"requestedBy": {
"type": "string"
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"initialTotal": {
"type": "integer"
},
"processed": {
"type": "integer"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"finishedAt": {
"type": "string",
"format": "date-time"
},
"pausedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"policyVersion",
"status",
"requestedBy",
"requestedAt",
"initialTotal",
"processed"
]
},
"RiskRevision": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"runId": {
"type": "string",
"format": "uuid"
},
"assetId": {
"type": "string"
},
"evidenceId": {
"type": [
"string",
"null"
]
},
"previousRisk": {
"anyOf": [
{
"$ref": "#/components/schemas/Risk"
},
{
"type": "null"
}
]
},
"risk": {
"$ref": "#/components/schemas/Risk"
},
"assessedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"runId",
"assetId",
"evidenceId",
"previousRisk",
"risk",
"assessedAt"
]
},
"Asset": {
"allOf": [
{
"type": "object",
"properties": {
"externalId": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"kind": {
"type": "string",
"enum": [
"tls",
"ssh",
"code",
"certificate",
"library",
"key",
"cloud",
"runtime"
]
},
"algorithm": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"keyEstablishment": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"authentication": {
"default": "unknown",
"type": "string",
"maxLength": 100
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"observedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"exposure": {
"default": "internal",
"type": "string",
"enum": [
"public",
"partner",
"internal",
"isolated"
]
},
"criticality": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"retentionYears": {
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"migrationFriction": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 5
},
"dependencyCount": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"dependencies": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"deadline": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"location": {
"type": "string",
"maxLength": 1000
},
"owner": {
"default": "Unassigned",
"type": "string",
"maxLength": 200
},
"evidence": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"externalId",
"name",
"kind",
"source",
"observedAt",
"confidence"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"firstSeen": {
"type": "string",
"format": "date-time"
},
"lastSeen": {
"type": "string",
"format": "date-time"
},
"evidenceId": {
"type": "string",
"format": "uuid"
},
"risk": {
"$ref": "#/components/schemas/Risk"
}
},
"required": [
"id",
"firstSeen",
"lastSeen",
"evidenceId",
"risk"
]
}
]
},
"ArchiveReceipt": {
"type": "object",
"properties": {
"state": {
"enum": [
"unarchived",
"pending",
"retrying",
"archived"
]
},
"sha256": {
"type": "string"
},
"byteLength": {
"type": "integer"
},
"archivedAt": {
"type": "string",
"format": "date-time"
},
"queuedAt": {
"type": "string",
"format": "date-time"
},
"attempts": {
"type": "integer"
},
"lastError": {
"type": "string"
},
"lastAttemptAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"state"
]
},
"Artifact": {
"type": "object",
"properties": {
"schema": {
"const": "sectigo.evidence.v1"
},
"canonicalization": {
"const": "qr-json-1"
},
"tenantId": {
"type": "string",
"format": "uuid"
},
"evidence": {
"$ref": "#/components/schemas/Evidence"
}
},
"required": [
"schema",
"canonicalization",
"tenantId",
"evidence"
]
},
"ArchiveStatus": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"archived": {
"type": "integer"
},
"pending": {
"type": "integer"
},
"retrying": {
"type": "integer"
},
"unarchived": {
"type": "integer"
}
},
"required": [
"total",
"archived",
"pending",
"retrying",
"unarchived"
]
},
"Evidence": {
"type": "object",
"properties": {
"archive": {
"$ref": "#/components/schemas/ArchiveReceipt"
},
"id": {
"type": "string",
"format": "uuid"
},
"assetId": {
"type": "string"
},
"submittedBy": {
"type": "string",
"format": "uuid"
},
"agentId": {
"type": "string",
"format": "uuid"
},
"jobId": {
"type": "string",
"format": "uuid"
},
"attempt": {
"type": "integer"
},
"receivedAt": {
"type": "string",
"format": "date-time"
},
"observation": {
"$ref": "#/components/schemas/Observation"
}
},
"required": [
"id",
"assetId",
"submittedBy",
"receivedAt",
"observation"
]
},
"Job": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"kind": {
"enum": [
"tls",
"code",
"ssh",
"capture"
]
},
"target": {
"type": "string"
},
"agentId": {
"type": "string",
"format": "uuid"
},
"status": {
"enum": [
"queued",
"running",
"completed",
"failed",
"cancelled"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"format": "uuid"
},
"attempts": {
"type": "integer"
},
"observationsAccepted": {
"type": "integer"
},
"observations": {
"type": "integer"
},
"leaseExpiresAt": {
"type": "string",
"format": "date-time"
},
"scheduleId": {
"type": "string",
"format": "uuid"
},
"scheduledFor": {
"type": "string",
"format": "date-time"
},
"orchestration": {
"type": "object",
"properties": {
"state": {
"enum": [
"pending",
"monitoring",
"finished"
]
},
"workflowId": {
"type": "string"
},
"lastCheckedAt": {
"type": "string",
"format": "date-time"
}
},
"required": []
},
"error": {
"type": "string"
},
"cancellationReason": {
"type": "string"
}
},
"required": [
"id",
"name",
"kind",
"target",
"agentId",
"status",
"createdAt",
"attempts"
]
},
"LeasedJob": {
"allOf": [
{
"$ref": "#/components/schemas/Job"
},
{
"type": "object",
"properties": {
"leaseToken": {
"type": "string"
},
"leaseExpiresAt": {
"type": "string",
"format": "date-time"
},
"protocolVersion": {
"const": 2
}
},
"required": [
"leaseToken",
"leaseExpiresAt",
"protocolVersion"
]
}
]
},
"Schedule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"kind": {
"enum": [
"tls",
"code",
"ssh",
"capture"
]
},
"target": {
"type": "string"
},
"agentId": {
"type": "string",
"format": "uuid"
},
"intervalSeconds": {
"type": "integer",
"minimum": 300,
"maximum": 2592000
},
"firstRunAt": {
"type": "string",
"format": "date-time"
},
"nextRunAt": {
"type": "string",
"format": "date-time"
},
"enabled": {
"type": "boolean"
},
"authorizedBy": {
"type": "string",
"format": "uuid"
},
"authorizedUserId": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"lastJobId": {
"type": "string",
"format": "uuid"
},
"lastRunAt": {
"type": "string",
"format": "date-time"
},
"lastEvaluatedAt": {
"type": "string",
"format": "date-time"
},
"pauseReason": {
"type": "string"
},
"skippedRuns": {
"type": "integer"
}
},
"required": [
"id",
"name",
"kind",
"target",
"agentId",
"intervalSeconds",
"nextRunAt",
"enabled",
"authorizedBy",
"createdAt",
"skippedRuns"
]
},
"AuditEvent": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actor": {
"type": "string"
},
"action": {
"type": "string"
},
"resource": {
"type": "string"
},
"at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"actor",
"action",
"resource",
"at"
]
},
"Plan": {
"type": "object",
"properties": {
"version": {
"type": "integer"
},
"criteria": {
"type": "object"
},
"verification": {
"type": "object"
},
"startedAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"lastReason": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"title": {
"type": "string"
},
"assetId": {
"type": "string"
},
"owner": {
"type": "string"
},
"dueDate": {
"type": "string",
"format": "date"
},
"status": {
"enum": [
"planned",
"in-progress",
"verified"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"title",
"assetId",
"owner",
"dueDate",
"status"
]
},
"AssetPage": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Asset"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"total": {
"type": "integer"
}
},
"required": [
"items",
"nextCursor",
"total"
]
},
"Receipt": {
"type": "object",
"properties": {
"accepted": {
"type": "integer"
},
"assetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"fingerprint": {
"type": "string"
},
"at": {
"type": "string",
"format": "date-time"
},
"replayed": {
"type": "boolean"
}
},
"required": [
"accepted",
"assetIds",
"fingerprint",
"at"
]
},
"Me": {
"type": "object",
"properties": {
"organization": {
"$ref": "#/components/schemas/Organization"
},
"identity": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"agentId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"name",
"role"
]
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
},
"required": [
"organization",
"identity",
"capabilities"
]
},
"Overview": {
"type": "object",
"properties": {
"assets": {
"type": "integer"
},
"evidence": {
"type": "integer"
},
"agents": {
"type": "integer"
},
"jobs": {
"type": "integer"
},
"averageRisk": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 100
},
"assessedAssets": {
"type": "integer"
},
"surfaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"surface": {
"type": "string"
},
"n": {
"type": "integer"
}
},
"required": [
"surface",
"n"
]
}
},
"topAssets": {
"type": "array",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/Asset"
}
},
"risk": {
"type": "array",
"items": {
"type": "object",
"properties": {
"severity": {
"type": "string"
},
"n": {
"type": "integer"
}
},
"required": [
"severity",
"n"
]
}
},
"policyVersion": {
"type": "string"
}
},
"required": [
"assets",
"evidence",
"agents",
"jobs",
"risk",
"policyVersion",
"averageRisk",
"assessedAssets",
"surfaces",
"topAssets"
]
},
"Cbom": {
"type": "object",
"properties": {
"bomFormat": {
"const": "CycloneDX"
},
"specVersion": {
"const": "1.7"
},
"serialNumber": {
"type": "string"
},
"version": {
"type": "integer"
},
"metadata": {
"type": "object"
},
"components": {
"type": "array",
"items": {
"type": "object"
}
},
"dependencies": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"bomFormat",
"specVersion",
"serialNumber",
"version",
"metadata",
"components",
"dependencies"
]
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"enum": [
"job.completed",
"job.failed",
"job.cancelled",
"plan.verified",
"evidence.archived"
]
}
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"testedAt": {
"type": "string",
"format": "date-time"
},
"revokedAt": {
"type": "string",
"format": "date-time"
},
"secretVersion": {
"type": "integer"
}
},
"required": [
"id",
"name",
"url",
"events",
"enabled",
"createdAt"
]
},
"WebhookDelivery": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"webhookId": {
"type": "string",
"format": "uuid"
},
"eventId": {
"type": "string",
"format": "uuid"
},
"eventType": {
"enum": [
"job.completed",
"job.failed",
"job.cancelled",
"plan.verified",
"evidence.archived",
"webhook.test"
]
},
"resourceId": {
"type": "string"
},
"state": {
"enum": [
"pending",
"sending",
"retrying",
"delivered",
"failed",
"cancelled"
]
},
"attempts": {
"type": "integer"
},
"cycleAttempts": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"nextAttemptAt": {
"type": "string",
"format": "date-time"
},
"finishedAt": {
"type": "string",
"format": "date-time"
},
"lastError": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"id",
"webhookId",
"eventId",
"eventType",
"resourceId",
"state",
"attempts",
"createdAt"
]
}
}