.svg)
The Security Audit Summary endpoint returns an aggregated overview of your organization's security posture. It covers the overall security score, password risk indicators, passkey adoption, vault distribution, breached websites, and two-factor authentication availability.
Use this endpoint for:
-
Leadership reporting and executive security dashboards
-
Periodic security reviews and compliance checks
-
Identifying high-risk areas that require administrative action
Required scope: Security Audit
Request
POST api/v1/security/overview/
This endpoint requires no request body or query parameters.
Response
Top-Level Fields
|
Field |
Type |
Description |
|---|---|---|
|
|
boolean |
|
|
|
string |
A machine-readable response identifier (e.g. |
|
|
string |
Overall security status of the organization (e.g. |
|
|
float |
Aggregated security score for the organization (0–100) |
|
|
timestamp |
Unix timestamp of the last audit data sync |
passwords
Aggregated metrics across all password items in the organization.
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Total number of password items across all vaults |
|
|
float |
Always |
|
|
integer |
Number of passwords excluded from the audit |
|
|
float |
Percentage of total passwords that are excluded |
|
|
integer |
Number of compromised passwords |
|
|
float |
Percentage of total passwords that are compromised |
|
|
integer |
Number of weak passwords |
|
|
float |
Percentage of total passwords that are weak |
|
|
integer |
Number of reused/identical passwords |
|
|
float |
Percentage of total passwords that are identical |
|
|
integer |
Number of passwords identical to SSO credentials |
|
|
float |
Percentage of total passwords matching SSO credentials |
|
|
integer |
Number of passwords not meeting your organization's policy |
|
|
float |
Percentage of total passwords that are non-compliant |
|
|
integer |
Number of expired passwords |
|
|
float |
Percentage of total passwords that are expired |
items
Aggregated metrics across all item types in the organization.
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Total number of items across all vaults |
|
|
float |
Always |
|
|
integer |
Number of items secured with a passkey |
|
|
float |
Percentage of total items using passkeys |
websites
Aggregated metrics related to websites associated with password items.
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Number of items associated with a breached website |
|
|
float |
Percentage of total passwords linked to breached websites |
|
|
integer |
Number of items where the associated website supports 2FA |
|
|
float |
Percentage of total passwords on 2FA-supported websites |
vaults
Aggregated breakdown of vaults across the organization.
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Total number of vaults in the organization |
|
|
float |
Always |
|
|
integer |
Number of primary vaults |
|
|
float |
Percentage of total vaults that are primary vaults |
|
|
integer |
Number of secondary (non-primary) vaults |
|
|
float |
Percentage of total vaults that are secondary vaults |
Example Response
{
"error": false,
"code": "audit_report",
"security": "at_risk",
"security_audit_score": 59,
"last_synced": 1776252306,
"passwords": {
"total_passwords": { "count": 4782, "percentage": 100.0 },
"excluded": { "count": 15, "percentage": 0.31 },
"compromised": { "count": 2415, "percentage": 50.5 },
"weak": { "count": 1393, "percentage": 29.13 },
"identical": { "count": 1453, "percentage": 30.38 },
"sso_identical": { "count": 0, "percentage": 0.0 },
"non_compliant": { "count": 1267, "percentage": 26.5 },
"expired": { "count": 2627, "percentage": 54.94 }
},
"items": {
"total_items": { "count": 6558, "percentage": 100.0 },
"passkey": { "count": 875, "percentage": 13.34 }
},
"websites": {
"breached": { "count": 66, "percentage": 1.38 },
"two_fa_available": { "count": 1477, "percentage": 30.89 }
},
"vaults": {
"total_vaults": { "count": 111, "percentage": 100.0 },
"primary_vaults": { "count": 11, "percentage": 9.91 },
"secondary_vaults": { "count": 100, "percentage": 90.09 }
}
}