Sign in

v1

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

Update Control

Use this API to update the attributes of a specific control in the Controls Library.

put/api/controls/v1/controls/{controlId}

Path parameters

controlIdstring uuid required

ID of the control. This value is obtained using Get List of Controls API.

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.

scopeIdstring uuid

The identifier of the scope associated with this control.

justificationIdsstring[]

Set of justification identifiers explaining why this control is included in the framework.

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",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "justificationIds": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ]
}

Response

OK

idstring uuid required

The identifier of the control.

identifierstring required

The identifier of the control.

namestring required

The name of the control.

descriptionstring

Description of the control.

orgGroupIdstring uuid required

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

orgGroupNamestring required

Organization Group Name of Control.

frameworkIdstring uuid

Identifier (GUID) of the framework on the control.

frameworkNamestring

Framework Name of Control.

frameworkNameKeystring

Framework Name key for Translation.

categoryIdstring uuid

Identifier (GUID) of the category on the control.

categoryNamestring

Name of the category on the control.

categoryNameKeystring

Identifier used for translation of Category Name.

seedControlIdstring uuid

The identifier of control that was seeded to the Master Control.

otControlIdentifierstring uuid

Unique OT identifier of Control.

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

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

attributesobject

Custom attributes for the control. These attributes are custom to the tenant.

implementationGuidancestring

Implementation guidance of the control requirement.

licensedContentMissingboolean

Flag which identify if any licensed content is missing and should obtain the license validation to view all content.

contentVersionstring

Indicates the content version of this record.

viewOnlyboolean

Flag indicating if this control is read-only and cannot be modified.

Example response

{
  "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "identifier": "A.5.1.1",
  "name": "Control Name",
  "description": "Test Controls for Privacy",
  "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "orgGroupName": "ABC Corp",
  "frameworkId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "frameworkName": "ISO/IEC 27017",
  "frameworkNameKey": "framework.key.iso",
  "categoryId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "categoryName": "Privacy",
  "categoryNameKey": "ControlName",
  "seedControlId": "123e4567-e89b-12d3-a456-426614174000",
  "otControlIdentifier": "123e4567-e89b-12d3-a456-426614174001",
  "status": "Active",
  "implementationGuidance": "Implementation guidance of the control requirement.",
  "contentVersion": "1.0"
}