Skip to content
Authrim

Get tenant compliance status.

GET
/api/admin/compliance/status
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/compliance/status \
  --header 'Authorization: Bearer <token>'

Returns the tenant’s compliance checks, each a fact read from what Authrim enforces and tagged with the frameworks whose controls it supports (data retention being enforced, audit logging, admin MFA, MFA required at sign-in, users’ MFA coverage, role-based access), each framework summed from its checks, and the facts behind them. Answers 503 when any of them cannot be read instead of reporting a default as the state. Retained whole-row archives are included in supported log queries. A bounded query that cannot read its required rows returns log_query_incomplete instead of partial statistics or an empty success.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Compliance status response.

Media type application/json
object
tenant_id
required
string
overall_status
required
string
Allowed values: compliant warning non_compliant not_applicable
frameworks
required

Each framework summed from the checks that support its controls.

Array<object>
object
framework
required
string
Allowed values: gdpr soc2 iso27001 pci_dss
status
required
string
Allowed values: compliant warning non_compliant not_applicable
compliant_checks
required
integer
warning_checks
required
integer
non_compliant_checks
required
integer
not_applicable_checks
required
integer
total_checks
required
integer
checks
required
Array<object>
object
id
required
string
Allowed values: data_retention_enforced audit_logging admin_mfa user_mfa_enforced user_mfa_coverage rbac_configured
frameworks
required
Array<string>
Allowed values: gdpr soc2 iso27001 pci_dss
status
required
string
Allowed values: compliant warning non_compliant not_applicable
facts
required

What the status was decided from.

object
key
additional properties
data_retention
required
object
expired_records
required
integer
attention
required
Array<object>
object
key
additional properties
audit_log
required
object
enabled
required
boolean
event_retention_days
required
integer | null
pii_retention_days
required
integer | null
total_entries
required

Null when the audit log cannot be queried here (an archive-only profile).

integer | null
entries_last_30_days
required
integer | null
hot_query_status
required
string
Allowed values: supported not_supported pending_runtime_support
mfa
required
object
enforcement
required
object
enforced
required

Sign-in requires AAL2 or above by default or for some scope.

boolean
assurance_enabled
required
boolean
default_aal
required
string | null
scopes_requiring_mfa
required
Array<string>
admins
required

Active admins who can administer the tenant; admin sign-in is passkey only.

object
admins
required
integer
with_passkey
required
integer
users
required

Active registered users over every store; guests apart.

object
users
required
integer
with_passkey
required
integer
with_totp
required
integer
with_any
required
integer
guests
required
integer
deleting
required
integer
access_control
required
object
active_roles
required
integer
users_with_roles
required

Users holding a role of the tenant: an unexpired role assignment or a role given by SCIM, each user once.

integer
accounts
required
object
pending_deletions
required

Accounts whose deletion has started and not finished.

integer
generated_at
required
string format: date-time
key
additional properties
Example 
{
  "overall_status": "compliant",
  "frameworks": [
    {
      "framework": "gdpr",
      "status": "compliant"
    }
  ],
  "checks": [
    {
      "id": "data_retention_enforced",
      "frameworks": [
        "gdpr"
      ],
      "status": "compliant"
    }
  ],
  "audit_log": {
    "hot_query_status": "supported"
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

The compliance status cannot be read; try again.