myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Create Control

post
https://{hostname}/api/controls/v1/controls

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

Body Params
string
required
length between 1 and 50

The identifier of the control.

string
required
length between 1 and 300

The name of the control.

uuid
required

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

string
length between 0 and 3000

Description of the control.

string
length between 0 and 500

The recommendation status of this control based on Athena logic.

uuid

Identifier of the framework the control is tied to.

string
length between 0 and 500

Name of the framework the control is tied to.

string
length between 0 and 500

Identifier used for translation of Framework Name.

string
enum

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

Allowed:
uuid

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

string
length between 0 and 500

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

string
length between 0 and 500

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

attributes
object

Custom Attributes

string

Implementation guidance of control.

uuid

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

uuid

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

string
enum
required

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

Allowed:
uuid

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
Response 
 Choose an example:
application/json
*/*
Updated 4 months ago