Skip to content
Authrim

List compliance reports.

GET
/api/admin/compliance/reports
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/compliance/reports?limit=20&status=generating&type=access_review' \
  --header 'Authorization: Bearer <token>'

Lists the tenant’s compliance reports, newest first, with cursor pagination. A completed report past its download period shows as expired.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 20 >= 1 <= 100

Maximum number of reports to return.

cursor
string

Opaque pagination cursor from a previous response.

status

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
type
string
Allowed values: access_review mfa_coverage compliance_status audit_log

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Compliance report list response.

Media type application/json
object
data
required
Array<object>
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
pagination
required
object
has_more
required
boolean
next_cursor
string
key
additional properties
key
additional properties
Example 
{
  "data": [
    {
      "type": "access_review",
      "status": "generating",
      "parameters": {
        "log_coverage": {
          "consistency": "snapshot"
        }
      },
      "format": "csv"
    }
  ]
}

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

500

Section titled “500 ”

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