patch/orgs/{orgId}/compliance/controls/{controlId}

Request

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

Path parameters

orgIdstring required

Organization identifier

controlIdstring required

Compliance control identifier

Request body

status'NOT_STARTED' | 'IN_PROGRESS' | 'IMPLEMENTED' | 'VERIFIED' | 'FAILED' required

New status for the control

ownerstring

Owner to assign

nextReviewAtstring

ISO 8601 next review date

Response

OK

idstring required

Unique control identifier

orgIdstring required

Organization identifier

framework'SOC2' | 'GDPR' | 'PCI' required

Compliance framework identifier

controlIdstring required

Control identifier (e.g. CC1.1)

titlestring required

Control title

descriptionstring required

Control description

category'CC1' | 'CC2' | 'CC3' | 'CC4' | 'CC5' | 'CC6' | 'CC7' | 'CC8' | 'CC9' | 'A1' | 'PI1' | 'C1' | 'P1' required

Trust Service Criteria category

status'NOT_STARTED' | 'IN_PROGRESS' | 'IMPLEMENTED' | 'VERIFIED' | 'FAILED' required

Current status of the compliance control

ownerstring nullable required

Owner responsible for this control

lastTestedAtstring nullable required

ISO 8601 timestamp of last test

nextReviewAtstring nullable required

ISO 8601 timestamp of next review

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.