Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Controls

Create Control

Use this API to create a new control in the Controls Library.

post/api/controls/v1/controls

Request body

identifierstring required

The identifier of the control.

namestring required

The name of the control.

orgGroupIdstring uuid required

The identifier of the organization the master control is linked to. In general, this is top organization in the org hierarchy.

descriptionstring

Description of the control.

recommendationstring

The recommendation status of this control based on Athena logic.

frameworkIdstring uuid

Identifier of the framework the control is tied to.

frameworkNamestring

Name of the framework the control is tied to.

frameworkNameKeystring

Identifier used for translation of Framework Name.

status'Active' | 'Archived' | 'Pending'

The new status of the control. This can be Active, Archived, or Pending.

categoryIdstring uuid

The identifier of the category tied to the control. Optional if no category is needed or if category name is provided.

categoryNamestring

The name of the category tied to the control. Optional if category Id is provided.

categoryNameKeystring

Identifier used for translation of category name. Optional if category Id is provided.

attributesobject

Custom Attributes

implementationGuidancestring

Implementation guidance of control.

seedControlIdstring uuid

The identifier of an existing control to use as a template for creating this new control.

importBatchIdstring uuid

The identifier of the import batch this control belongs to when importing multiple controls.

origin'BulkImport' | 'Manual' | 'FrameworkImport' | 'FrameworkContentUpdate' required

The origin or creation method of this control (Manual, Import, API, etc.).

otControlIdentifierstring uuid

The OneTrust system identifier for this control when importing from the OneTrust catalog.

Example request

{
  "identifier": "A.1.1",
  "name": "Control ABC",
  "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "description": "Testing Control",
  "recommendation": "Recommended",
  "frameworkId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "frameworkName": "NIST",
  "frameworkNameKey": "framework.NIST",
  "status": "Active",
  "categoryId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "categoryName": "Access Control",
  "categoryNameKey": "category.AccessControl",
  "implementationGuidance": "Testing Control",
  "seedControlId": "123e4567-e89b-12d3-a456-426614174000",
  "importBatchId": "123e4567-e89b-12d3-a456-426614174001",
  "origin": "Manual",
  "otControlIdentifier": "123e4567-e89b-12d3-a456-426614174002"
}

Response

Created

idstring uuid required

Primary identifier of the created or updated entity, typically a UUID.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}