post/orgs/{orgId}/compliance/reports

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/orgs/{orgId}/compliance/reports
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

orgIdstring required

Organization identifier

Request body

type'SOC2_SUMMARY' | 'ACTIVITY_REPORT' | 'ACCESS_REVIEW' | 'AUDIT_EXPORT' | 'GDPR_DSAR' required

Type of compliance report

titlestring

Custom report title

descriptionstring

Custom report description

format'JSON' | 'CSV' | 'PDF'

Report format

generatedBystring

User generating the report

periodStartstring

ISO 8601 report period start

periodEndstring

ISO 8601 report period end

parametersobject

Additional template-specific parameters

Response

OK

idstring required

Unique report identifier

orgIdstring required

Organization identifier

type'SOC2_SUMMARY' | 'ACTIVITY_REPORT' | 'ACCESS_REVIEW' | 'AUDIT_EXPORT' | 'GDPR_DSAR' required

Type of compliance report

titlestring required

Report title

descriptionstring nullable required

Report description

status'PENDING' | 'GENERATING' | 'COMPLETED' | 'FAILED' required

Current status of the report

format'JSON' | 'CSV' | 'PDF' required

Export format for the report

parametersobject required

Report generation parameters

contentobject nullable required

Report content data

errorMessagestring nullable required

Error message if report generation failed

generatedBystring nullable required

User who generated the report

periodStartstring nullable required

ISO 8601 report period start

periodEndstring nullable required

ISO 8601 report period end

completedAtstring nullable required

ISO 8601 completion timestamp

createdAtstring required

ISO 8601 creation timestamp

updatedAtstring required

ISO 8601 last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.