コンテンツにスキップ
Authrim

Create a report generation job.

POST
/api/admin/jobs/reports/generate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/jobs/reports/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "user_activity", "from_date": "2026-02-01T00:00:00.000Z", "to_date": "2026-02-28T23:59:59.000Z", "format": "json", "result_delivery": "auto" }'

Queues a reports/generate job after validating report type, output format, ISO date range, and the maximum 90-day window.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
type
required
string
Allowed values: user_activity access_summary compliance_audit security_events
from_date
required
string format: date-time
to_date
required
string format: date-time
format
string
default: json
Allowed values: json csv
filters
object
key
additional properties
result_delivery
string
Allowed values: auto inline artifact
key
additional properties
Example 
{
  "type": "user_activity",
  "from_date": "2026-02-01T00:00:00.000Z",
  "to_date": "2026-02-28T23:59:59.000Z",
  "format": "json",
  "result_delivery": "auto"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Report generation job accepted response.

Media type application/json
object
job_id
required
string
status
required
string
Allowed values: pending
job_type
required
string
created_at
required
string format: date-time
estimated_completion
required
string format: date-time
report_type
required
string
format
required
string
Allowed values: json csv
Example 
{
  "status": "pending",
  "format": "json"
}

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

409

Section titled “409 ”

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