Skip to content
Authrim

Get a compliance report.

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The report.

Media type application/json
object
report_id
required
string
type
required
string
Allowed values: access_review mfa_coverage compliance_status audit_log
name
required
string
status
required

Generating (stored, its generation not audited yet; not downloadable), failed (error says why), expired (its download period ended; its file is deleted).

string
Allowed values: generating completed failed expired
requested_by
required
string | null
parameters
required
object
log_coverage
object
consistency
required
string
Allowed values: snapshot eventual local_hot_only
pending_deliveries
required

Null for self-service subjects that cannot inspect tenant delivery counts.

integer | null
complete
required

Pipeline and local staging-only views remain false even when no pending deliveries are known.

boolean
key
additional properties
format
required
string | null
Allowed values: csv json
row_count
required
integer | null
size_bytes
required
integer | null
sha256
required

The file’s SHA-256, checked on every download.

string | null
error
required
string | null
created_at
required
string format: date-time
completed_at
required
string | null format: date-time
expires_at
required
string | null format: date-time
downloadable
required
boolean
key
additional properties
Example 
{
  "type": "access_review",
  "status": "generating",
  "parameters": {
    "log_coverage": {
      "consistency": "snapshot"
    }
  },
  "format": "csv"
}

Headers

Section titled “Headers ”
X-Authrim-Log-Consistency
string
Allowed values: snapshot eventual local_hot_only

Snapshot for the remote scheduled view; eventual when Pipeline visibility can lag ingestion; local_hot_only for local scheduled staging without a remote Catalog.

X-Authrim-Log-Pending-Deliveries
integer

Tenant deliveries not yet confirmed visible. Omitted for self-service subjects. Zero does not guarantee immediate Pipeline visibility.

X-Authrim-Log-Complete
boolean

True only for a complete bounded snapshot query. Pipeline responses remain false; incomplete reads return 503.

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"
}

404

Section titled “404 ”

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"
}