Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
250 changes: 35 additions & 215 deletions docs/api-schema-snapshot.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
{
"generatedAt": "2026-06-29T08:01:48Z",
"_meta": {
"notes": [
"Types use suffixes: '?' = nullable, '*' = pattern key. Bare types are observed-required-non-null in the sample.",
"Arrays use `_itemProperties` when the documented item shape is known; bare `\"array\"` only when items are truly schemaless (e.g. variant strings).",
"Nullable handling: API contract types are documented at docs/API-REFERENCE.md and considered the source of truth; sampled responses that happen to contain nulls do not collapse the documented type.",
"Reports / Assessment endpoints are part of the public surface in v0.5.0 and are included here."
]
},
"generatedAt": "2026-07-06T07:47:28Z",
"endpoints": {
Comment on lines 1 to 3
"GET /beta/tenants": {
Comment on lines 3 to 4
"properties": {
Expand All @@ -19,20 +11,9 @@
"isBaseline": "boolean",
"lastBackupTimestamp": "datetime",
"recentChanges": "integer",
"policyDiff": "string?",
"policyDiff": "string",
"tags": "array",
"alignmentSummaries": {
"_type": "array",
"_itemProperties": {
"alignedBaselineTenantId": "integer",
"alignedBaselineId": "string",
"alignedBaselineName": "string",
"alignmentScore": "number",
"alignedThreshold": "number",
"semiAlignedThreshold": "number",
"lastAlignmentDateTime": "datetime"
}
},
"alignmentSummaries": "array",
"licenses": {
"_type": "array",
"_itemProperties": {
Expand All @@ -51,15 +32,7 @@
"baselineMsTenantId": "string",
"alignedThreshold": "integer",
"semiAlignedThreshold": "integer",
"members": {
"_type": "array",
"_itemProperties": {
"clientTenantId": "integer",
"tenantFriendlyName": "string",
"tenantDnsName": "string",
"msTenantId": "string"
}
},
"members": "array",
"mode": "string",
"autoAddNewPolicies": "boolean",
"isComplete": "boolean",
Expand All @@ -68,10 +41,10 @@
"_type": "array",
"_itemProperties": {
"policySnapshotId": "string",
"childCustomBaselineId": "string?",
"policyCategoryProduct": "string?",
"policyCategoryPrimaryGroup": "string?",
"policyCategorySecondaryGroup": "string?",
"childCustomBaselineId": "null",
"policyCategoryProduct": "null",
"policyCategoryPrimaryGroup": "null",
"policyCategorySecondaryGroup": "null",
Comment on lines +44 to +47
"alignAssignments": "boolean"
Comment on lines +44 to 48
}
}
Expand All @@ -81,7 +54,7 @@
"properties": {
"tenantId": "integer",
"tenantFriendlyName": "string",
"score": "number",
"score": "integer",
"baselineGroupId": "string",
"baselineGroupName": "string",
"lastComparisonDateTime": "datetime"
Expand All @@ -91,15 +64,15 @@
"properties": {
"id": "string",
"policyTypeId": "integer",
"name": "string?",
"name": "null",
"displayName": "string",
"friendlyName": "string",
"description": "string?",
"description": "null",
Comment on lines +67 to +70
Comment on lines +67 to +70
"readOnly": "boolean",
"product": "string",
"primaryGroup": "string",
"secondaryGroup": "string",
"platform": "string?",
"platform": "null",
"policyCategoryId": "integer",
"tags": "array",
"policyData": "object"
Expand All @@ -126,7 +99,7 @@
"subjectTenantId": "integer",
"subjectDataTimestamp": "datetime",
"baselineDataTimestamp": "datetime",
"alignmentScore": "number",
"alignmentScore": "integer",
"deviatedUnaccepted": "array",
"matchedPolicies": {
"_type": "array",
Expand All @@ -138,7 +111,7 @@
"_itemProperties": {
"subjectPolicySnapshotId": "string",
"subjectPolicySnapshotVersionId": "string",
"subjectPolicyGuid": "string?",
"subjectPolicyGuid": "string",
"policyDataDiff": "array",
"policyAssignmentsDiff": "array",
"policyTags": "array",
Expand All @@ -148,41 +121,29 @@
"isDeviation": "boolean",
"isMissingFromSubject": "boolean",
"isAdditionalInSubject": "boolean",
"matchingVariables": {
"_type": "array",
"_itemProperties": {
"variableId": "string",
"variableName": "string",
"baselineValue": "string?",
"subjectValue": "string?",
"description": "string?",
"propertyPath": "string",
"isHidden": "boolean",
"isBaselineOnly": "boolean"
}
},
"matchingVariables": "array",
"similarPolicies": "array",
"acceptedDeviations": "array",
"policyGuid": "string?",
"policyGuid": "string",
"policyName": "string",
"policySnapshotId": "string?",
"policySnapshotVersionId": "string?",
"policySnapshotId": "null",
"policySnapshotVersionId": "null",
Comment on lines +129 to +130
"policyTypeId": "integer",
"inforcerPolicyTypeName": "string",
"policyCategoryId": "integer",
"product": "string",
"primaryGroup": "string",
"secondaryGroup": "string",
"platform": "string?",
"description": "string?",
"platform": "null",
"description": "null",
Comment on lines +137 to +138
"isPolicyDeleteDisabled": "boolean",
"isPolicyDeployable": "boolean",
"policyTags": {
"_type": "array",
"_itemProperties": {
"id": "string",
"name": "string",
"description": "string?"
"description": "null"
}
},
"readOnly": "boolean",
Expand Down Expand Up @@ -218,12 +179,12 @@
"_properties": {
"clientIp": "string",
"clientIpv4": "string",
"clientIpv6": "string?",
"clientIpv6": "null",
"nameLookup": {
"_type": "object",
"_patternProperties": {
"user:username:*": "string",
"user:displayName:*": "string"
"_properties": {
"user:username:244": "string",
"user:displayName:244": "string"
}
Comment on lines +185 to 188
Comment on lines +185 to 188
Comment on lines 184 to 188
}
}
Expand All @@ -234,25 +195,25 @@
"properties": {
"id": "string",
"displayName": "string",
"description": "string?",
"mail": "string?",
"visibility": "string?",
"description": "string",
"mail": "string",
"visibility": "string",
Comment on lines +198 to +200
Comment on lines +198 to +200
"groupTypes": "array"
}
},
"GET /beta/tenants/{tenantId}/groups/{groupId}": {
"properties": {
"id": "string",
"displayName": "string",
"description": "string?",
"mail": "string?",
"mailNickname": "string?",
"visibility": "string?",
"membershipRule": "string?",
"description": "string",
"mail": "string",
"mailNickname": "string",
"visibility": "string",
"membershipRule": "null",
Comment on lines +208 to +212
"groupTypes": "array",
"createdDateTime": "datetime",
"mailEnabled": "boolean",
"onPremisesSyncEnabled": "boolean?",
"onPremisesSyncEnabled": "null",
"members": {
"_type": "array",
"_itemProperties": {
Expand All @@ -268,152 +229,11 @@
"id": "string",
"templateId": "string",
"displayName": "string",
"description": "string?",
"description": "string",
"isBuiltIn": "boolean",
"isEnabled": "boolean",
"isPrivileged": "boolean"
}
},
"GET /beta/assessments": {
"properties": {
"id": "string",
"name": "string",
"description": "string?",
"tags": "array",
"assessmentType": "string",
"lastUpdated": "datetime",
"created": "datetime"
}
},
"POST /beta/tenants/{tenantId}/assessments/{assessmentId}/runs": {
"properties": {
"assessment": "string",
"name": "string",
"results": {
"_type": "array",
"_itemProperties": {
"id": "string",
"key": "string",
"name": "string",
"category": "string",
"subCategory": "string?",
"description": "string?",
"importance": "string",
"impact": "string?",
"rationale": "string?",
"remediation": "string?",
"findings": {
"_type": "object",
"_properties": {
"compliant": "boolean",
"message": "string?",
"scores": {
"_type": "array",
"_itemProperties": {
"objectId": "string",
"score": "number",
"objectName": "string?",
"passes": "array",
"violations": "array",
"warnings": "array"
}
}
}
},
"frameworks": "array",
"tags": "array",
"version": "string?",
"created": "datetime",
"lastUpdated": "datetime"
}
}
}
},
"GET /beta/reports/types": {
"properties": {
"key": "string",
"name": "string",
"description": "string?",
"collatable": "boolean",
"supportedOutputFormats": "array",
"requiredParameters": "array",
"tags": "array"
}
},
"POST /beta/reports/runs": {
"properties": {
"runId": "string",
"status": "string",
"reportTypes": "array",
"outputFormats": "array",
"triggeredByType": "string",
"createdAt": "datetime",
"startedAt": "datetime?",
"completedAt": "datetime?",
"outputCount": "integer"
}
},
"GET /beta/reports/runs": {
"properties": {
"runId": "string",
"status": "string",
"reportTypes": "array",
"outputFormats": "array",
"triggeredByType": "string",
"createdAt": "datetime",
"startedAt": "datetime?",
"completedAt": "datetime?",
"outputCount": "integer"
}
},
"GET /beta/reports/runs/{runId}/outputs": {
"properties": {
"outputs": {
"_type": "array",
"_itemProperties": {
"id": "string",
"reportType": "string",
"tenantId": "integer",
"format": "string",
"sizeBytes": "integer"
}
}
}
},
"GET /beta/reports/runs/{runId}/outputs/{outputId}": {
"_responseType": "binary",
"_headers": {
"Content-Disposition": "string (RFC 5987 filename*= or filename=)",
"Content-Type": "string",
"x-correlation-id": "string"
}
},
"GET /beta/tenants/{tenantId}/users": {
"properties": {
"id": "string",
"displayName": "string",
"userPrincipalName": "string",
"userType": "string?",
"department": "string?",
"assignedLicenses": "array",
"isGlobalAdmin": "boolean",
"isMfaCapable": "boolean"
}
},
"GET /beta/tenants/{tenantId}/users/{userId}": {
"properties": {
"id": "string",
"displayName": "string",
"userPrincipalName": "string",
"userType": "string?",
"department": "string?",
"mail": "string?",
"accountEnabled": "boolean",
"isGlobalAdmin": "boolean",
"isCloudOnly": "boolean",
"isMfaRegistered": "boolean",
"riskLevel": "string?"
}
}
}
}
Comment on lines 238 to 239