コンテンツにスキップ
Authrim

Generate a compliance report.

POST
/api/admin/compliance/reports
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/compliance/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "access_review", "name": "example", "parameters": { "review_id": "example", "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" } }'

Generates a report now and keeps its file encrypted for 30 days (downloadable once its generation is audited: generating until then): access_review (an access review’s items, decisions and what applying them did; CSV), mfa_coverage (each admin and active user and their factors; CSV), compliance_status (the status API’s answer at this moment; JSON), audit_log (audit log entries of a period of up to 366 days from the queryable audit store; CSV). Rows identify people by their IDs, never adding names or email addresses; the reasons reviewers wrote are included as written. A report of more than 10,000 rows is not cut short: it is recorded as failed (too_large) and answered 422. Generating is audited.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
type
required
string
Allowed values: access_review mfa_coverage compliance_status audit_log
name
string
>= 1 characters <= 200 characters
parameters

Review_id for access_review; from and to (date-times, to after from, at most 366 days apart) for audit_log.

object
review_id
string
from
string format: date-time
to
string format: date-time
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The generated 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.

400

Section titled “400 ”

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

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 ”

The access review does not exist.

409

Section titled “409 ”

The tenant keeps no audit log that can be queried (audit_log_not_queryable).

422

Section titled “422 ”

More rows than one report holds; the report is recorded as failed.

Media type application/json
object
error
required
string
Allowed values: report_too_large
error_description
string
report
required
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 
{
  "error": "report_too_large",
  "report": {
    "type": "access_review",
    "status": "generating",
    "parameters": {
      "log_coverage": {
        "consistency": "snapshot"
      }
    },
    "format": "csv"
  }
}

503

Section titled “503 ”

Report storage is unavailable, generation cannot complete, or required retained log data cannot be read (log_query_incomplete, complete: false). No partial audit report is published.

Media type application/json
object
error
required
string
complete
boolean
key
additional properties
Example 
{
  "complete": false
}