> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enable Attribute

Use this API to enable an attribute.

> 🗒 Things to Know
> 
> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation. 

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "AI Governance - AI Governance",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The AI Governance APIs are used to integrate external systems and streamline the flow of data with AI Governance in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Attribute Management",
      "description": "The Attribute Management APIs are used to manage attributes associated with AI Governance entities.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/ai-governance/v1/schema-attributes/{attributeId}/enable": {
      "put": {
        "operationId": "enableAttributeUsingPUT",
        "summary": "Enable Attribute",
        "description": "Use this API to enable an attribute.\n\n> 🗒 Things to Know\n> \n> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).\n> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation. ",
        "tags": [
          "Attribute Management"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
        },
        "parameters": [
          {
            "name": "schemaId",
            "in": "query",
            "description": "Unique identifier of the schema containing the attribute",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          {
            "name": "attributeId",
            "in": "path",
            "description": "Unique identifier of the attribute to be enabled",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Enabled attribute details",
                  "$ref": "#/components/schemas/AttributeInformation"
                },
                "examples": {
                  "Enabled Attribute Response": {
                    "summary": "Response after enabling an attribute",
                    "description": "Details of the attribute after it has been enabled",
                    "value": {
                      "id": "1ba369d0-ebcd-4340-82ff-aab02f94ae9d",
                      "name": "Test 1",
                      "nameKey": "OneTrustApp.AIG.Attributes.c19fc626-5e0d-4104-b35b-7a6bea71c8c3",
                      "description": "Test 1",
                      "descriptionKey": "OneTrustApp.AIG.Attributes.16f33cf1-a6cc-4ed6-859b-4f66021b380e",
                      "fieldName": "attributeTextValue.value2_32",
                      "mappedFieldName": "attributeTextValue.value2",
                      "enabled": true,
                      "required": false,
                      "readOnly": false,
                      "encrypted": false,
                      "allowOther": false,
                      "baseAttribute": false,
                      "responseType": "Text",
                      "formula": null,
                      "optionType": "none",
                      "optionAllowed": false,
                      "schemaId": "060ef603-4948-4dc6-89da-bd095ab52cfe",
                      "schemaName": "aisystems",
                      "responseMaxLength": 1000,
                      "source": null,
                      "responseSubType": null,
                      "multiSelectMaxOptionValues": null,
                      "hidden": false,
                      "abacBasicAssignmentInfo": null,
                      "associatedAttributeFieldName": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "AI_GOVERNANCE",
              "AI_GOVERNANCE_WRITE"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AbacBasicAssignmentInfo": {
        "type": "object",
        "properties": {
          "assignmentId": {
            "description": "GUID of the linked assignment",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "assignmentName": {
            "description": "Name of the linked assignment",
            "type": "string",
            "example": "Assignment1"
          },
          "policyStatus": {
            "description": "Policy status of the linked assignment",
            "type": "string",
            "example": "ACTIVE",
            "enum": [
              "INACTIVE",
              "ACTIVE",
              "PROCESSING",
              "FAILED"
            ]
          }
        }
      },
      "AssociatedAttributeInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Associated Attribute GUID",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Name",
            "type": "string",
            "example": "Count of members",
            "minLength": 1
          },
          "nameKey": {
            "description": "Name key",
            "type": "string",
            "example": "IM.CountOfMembersName"
          },
          "description": {
            "description": "Description",
            "type": "string",
            "example": "Provide details about count associated with this attribute"
          },
          "descriptionKey": {
            "description": "Description Key",
            "type": "string",
            "example": "IM.CountOfMembersDesc"
          },
          "schemaId": {
            "description": "Attribute Schema GUID",
            "type": "string",
            "format": "uuid"
          },
          "schemaName": {
            "description": "Attribute Schema Name",
            "type": "string",
            "example": "risk"
          },
          "fieldName": {
            "description": "Attribute field name",
            "type": "string",
            "example": "countOfMembers",
            "minLength": 1
          },
          "mappedFieldName": {
            "description": "Mapped Attribute field name. Should be used for sorting",
            "type": "string",
            "example": "count"
          },
          "enabled": {
            "description": "Indicator for attribute enabled/disabled",
            "type": "boolean"
          },
          "responseType": {
            "description": "Response Type",
            "type": "string",
            "enum": [
              "Text",
              "SingleSelect",
              "MultiSelect",
              "Date",
              "DateTime",
              "NumericalText",
              "NumericalSingleSelect",
              "RadioButton",
              "TextArea",
              "Formula",
              "Level",
              "Range",
              "Score",
              "System"
            ]
          },
          "responseSubType": {
            "description": "Response sub type",
            "type": "string",
            "enum": [
              "Standard",
              "Formula",
              "Matrix",
              "RollUp"
            ]
          },
          "formula": {
            "description": "Formula for attribute",
            "type": "string",
            "example": "sum(1, 3)"
          },
          "options": {
            "description": "Attribute options",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttributeOptionInformation"
            }
          },
          "optionsByDomain": {
            "description": "Override options by Domain",
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AttributeDomainOptionOverrideInformation"
              }
            }
          }
        },
        "required": [
          "enabled",
          "fieldName",
          "id",
          "responseType"
        ]
      },
      "AttributeDomainOptionOverrideInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Override Option GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "attributeDomainOptionId": {
            "description": "Domain Option GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440001"
          },
          "targetAttributeId": {
            "description": "Target Attribute GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440002"
          },
          "targetOptionId": {
            "description": "Target Option GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440003"
          },
          "option": {
            "description": "Option name",
            "type": "string",
            "example": "TypeA"
          },
          "optionKey": {
            "description": "Option name key",
            "type": "string",
            "example": "TypeB"
          },
          "optionSelectionValue": {
            "description": "Option selection value",
            "type": "string",
            "example": 10
          },
          "colorCode": {
            "description": "Color code for the option",
            "type": "string",
            "example": "#FF5733",
            "maxLength": 7
          },
          "sequence": {
            "description": "Option sequence for ordering",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "maximum": 32767,
            "minimum": 1
          },
          "enabled": {
            "description": "Indicates if the option is enabled or disabled",
            "type": "boolean",
            "example": true,
            "default": "true"
          },
          "metadata": {
            "description": "Additional metadata for the attribute option",
            "$ref": "#/components/schemas/AttributeOptionMetadata"
          },
          "optionSelectionValueAsDouble": {
            "type": "number",
            "format": "double"
          },
          "optionAsDouble": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "AttributeFormulaDetail": {
        "type": "object",
        "properties": {
          "formula": {
            "type": "string"
          },
          "formulaType": {
            "type": "string"
          }
        }
      },
      "AttributeInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Attribute GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "name": {
            "description": "Attribute name",
            "type": "string",
            "example": "Type of the Record",
            "maxLength": 255,
            "minLength": 1
          },
          "nameKey": {
            "description": "Attribute name key which can be used for translation",
            "type": "string",
            "example": "IM.Name",
            "maxLength": 255
          },
          "description": {
            "description": "Attribute description",
            "type": "string",
            "example": "Gather Type for the record - provide some value related to nature of record",
            "maxLength": 1000
          },
          "descriptionKey": {
            "description": "Attribute description key which can be used for translation",
            "type": "string",
            "example": "IM.Name.Description",
            "maxLength": 255
          },
          "fieldName": {
            "description": "Attribute field name which can be used for uniquely identifying an attribute",
            "type": "string",
            "example": "nameOfRecord",
            "maxLength": 100,
            "minLength": 1
          },
          "mappedFieldName": {
            "description": "Mapped Attribute field name. Should be used for sorting",
            "type": "string",
            "example": "name",
            "maxLength": 100
          },
          "enabled": {
            "description": "Indicator for attribute enabled/disabled",
            "type": "boolean",
            "example": true,
            "default": "true"
          },
          "required": {
            "description": "Indicator for mandatory attribute",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "readOnly": {
            "description": "Indicator for read only attribute",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "encrypted": {
            "description": "Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "allowOther": {
            "description": "Indicator for allowing user defined options for attribute",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "baseAttribute": {
            "description": "Indicate if attribute is part of extendable entity and which cannot be modified",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "responseType": {
            "description": "Response type for attribute",
            "type": "string",
            "example": "Text",
            "enum": [
              "Text",
              "SingleSelect",
              "MultiSelect",
              "Date",
              "Formula",
              "Score",
              "Level",
              "Range"
            ]
          },
          "formula": {
            "description": "Formula for attribute",
            "type": "string",
            "example": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
            "maxLength": 4000
          },
          "optionType": {
            "description": "Attribute Options value source type",
            "type": "string",
            "example": "None",
            "enum": [
              "None",
              "Static",
              "Dynamic"
            ]
          },
          "optionAllowed": {
            "description": "Indicate if attribute can have static options or not",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "schemaId": {
            "description": "Attribute Schema GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "schemaName": {
            "description": "Attribute Schema Name",
            "type": "string",
            "example": "vendors",
            "maxLength": 100
          },
          "options": {
            "description": "Option's for given attribute based on response type",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttributeOptionInformation"
            }
          },
          "referenceCategories": {
            "description": "Categories for given attribute",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CategoryInformation"
            }
          },
          "responseMaxLength": {
            "description": "Response max length",
            "type": "integer",
            "format": "int32",
            "example": 4000,
            "default": "4000",
            "maximum": 4000,
            "minimum": 1
          },
          "responseSubType": {
            "description": "Response sub type",
            "type": "string",
            "example": "STANDARD",
            "enum": [
              "STANDARD",
              "FORMULA",
              "MATRIX"
            ]
          },
          "associatedAttributeInformation": {
            "description": "Associated attribute information",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociatedAttributeInformation"
            }
          },
          "multiSelectMaxOptionValues": {
            "description": "MultiSelect max option values",
            "type": "integer",
            "format": "int32",
            "example": 10,
            "maximum": 100,
            "minimum": 1
          },
          "hidden": {
            "description": "Hidden",
            "type": "boolean",
            "example": false,
            "default": "false"
          },
          "optionUrl": {
            "description": "OptionUrl",
            "type": "string",
            "example": "/api/risk-v2/risk-categories",
            "maxLength": 255
          },
          "intakeQuestion": {
            "description": "Attribute Intake Question Details",
            "$ref": "#/components/schemas/IntakeQuestion"
          },
          "deleteMarker": {
            "description": "Indicate the status of an attribute's deletion process",
            "type": "string",
            "example": "MARKED_FOR_DELETE",
            "enum": [
              "MARKED_FOR_DELETE",
              "DELETING",
              "DELETED"
            ]
          },
          "optionMetadata": {
            "description": "Option Metadata",
            "$ref": "#/components/schemas/AttributeOptionMetadataInformation"
          },
          "validationRuleId": {
            "description": "Validation Rule configured for Attribute (e.g., email, URL)",
            "type": "string",
            "example": "email"
          },
          "abacBasicAssignmentInfo": {
            "description": "Contains the id, name and ObjectType of the linked assignment",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AbacBasicAssignmentInfo"
            }
          },
          "optionsByDomain": {
            "description": "Override options by Domain",
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AttributeDomainOptionOverrideInformation"
              }
            }
          },
          "formulaByDomain": {
            "description": "Formula by Domain",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/AttributeFormulaDetail"
            }
          },
          "displayResponseType": {
            "description": "Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues",
            "type": "string",
            "example": "SingleSelect",
            "enum": [
              "Text",
              "SingleSelect",
              "MultiSelect",
              "Date",
              "DateTime",
              "NumericalText",
              "NumericalSingleSelect",
              "RadioButton",
              "TextArea",
              "Formula",
              "Level",
              "Range",
              "Score",
              "System"
            ]
          },
          "associatedAttributeFieldName": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "fieldName",
          "name"
        ]
      },
      "AttributeOptionInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Option GUID",
            "type": "string",
            "format": "uuid",
            "example": "550e8400-e29b-41d4-a716-446655440000"
          },
          "option": {
            "description": "Option name",
            "type": "string",
            "example": "TypeA",
            "maxLength": 255,
            "minLength": 1
          },
          "optionKey": {
            "description": "Option Key which can be used for translation",
            "type": "string",
            "example": "IM.TypeA",
            "maxLength": 255
          },
          "colorCode": {
            "description": "Color code for the option",
            "type": "string",
            "example": "#FF5733",
            "maxLength": 7
          },
          "sequence": {
            "description": "Option sequence for ordering",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "maximum": 32767,
            "minimum": 1
          },
          "enabled": {
            "description": "Indicates if the option is enabled or disabled",
            "type": "boolean",
            "example": true,
            "default": "true"
          },
          "metadata": {
            "description": "Additional metadata for the attribute option",
            "$ref": "#/components/schemas/AttributeOptionMetadata"
          }
        },
        "required": [
          "option"
        ]
      },
      "AttributeOptionMetadata": {
        "type": "object",
        "properties": {
          "hint": {
            "description": "Hint",
            "type": "string"
          },
          "hintKey": {
            "description": "Hint key which can be used for translation",
            "type": "string"
          }
        }
      },
      "AttributeOptionMetadataInformation": {
        "type": "object",
        "properties": {
          "entityTypeName": {
            "description": "Option Source Entity Type",
            "type": "string",
            "example": "Location"
          },
          "basicServiceContextPath": {
            "description": "Basic Url for the Option source Service",
            "type": "string",
            "example": "/api/location"
          },
          "optionUrl": {
            "description": "Api URL for the Drop Down Api",
            "type": "string",
            "example": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages"
          },
          "optionListUrl": {
            "description": "Api URL for the Drop Down Api. Complete List of entities",
            "type": "string",
            "example": "/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details"
          },
          "viewType": {
            "description": "This will help to identify the view type of list",
            "type": "string"
          },
          "optionType": {
            "description": "Option Type",
            "type": "string",
            "example": "BusinessLocations"
          },
          "permissions": {
            "description": "Permissions",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": "[features.core-constructs.view]"
          },
          "applicationUrl": {
            "description": "Application Url",
            "type": "string",
            "example": "/settings/location-management/location/Location"
          }
        }
      },
      "CategoryInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Category unique identifier",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "description": "Category name",
            "type": "string",
            "example": "Financial Category"
          },
          "nameKey": {
            "description": "Category nameKey for localization support",
            "type": "string",
            "example": "IM.FinancialCategoryName"
          }
        }
      },
      "IntakeQuestion": {
        "type": "object",
        "properties": {
          "nameKey": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
          },
          "name": {
            "type": "string",
            "maxLength": 500,
            "minLength": 0
          },
          "descriptionKey": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
          },
          "description": {
            "type": "string",
            "maxLength": 500,
            "minLength": 0
          }
        }
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "AI_GOVERNANCE": "Grants full permissions to manage AI Governance operations for external systems",
              "AI_GOVERNANCE_READ": "Allows read-only access to AI Governance entities",
              "AI_GOVERNANCE_WRITE": "Grants permissions to create and modify AI Governance entities"
            }
          }
        }
      }
    }
  }
}
```